summaryrefslogtreecommitdiff
authorNeil Marion dela Cruz <nmfdelacruz@gmail.com>2013-08-16 03:59:10 (UTC)
committer Neil Marion dela Cruz <nmfdelacruz@gmail.com>2013-08-16 03:59:10 (UTC)
commit0b83c936753726adf63a6fbdbb8df166d1552f25 (patch) (unidiff)
tree530fc51198f33b481c48b360d3b9aebcc16f5733
parent303600d0d45fd61b922f5278a6f1efb9574be5e8 (diff)
downloadclipperz-0b83c936753726adf63a6fbdbb8df166d1552f25.zip
clipperz-0b83c936753726adf63a6fbdbb8df166d1552f25.tar.gz
clipperz-0b83c936753726adf63a6fbdbb8df166d1552f25.tar.bz2
Update README.md
I was clueless at first why I'm not redirected to POG when I went to /setup/ . Then I realized that I needed to input my setup_password on the textfield when I inspected the element.
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index e44df48..414527f 100644
--- a/README.md
+++ b/README.md
@@ -16,103 +16,105 @@ Read more on the [Clipperz website][home].
16## Why an open source version 16## Why an open source version
17 17
18Because we want to enable as many people as possible to play with our code. So that you can start trusting it, the code not the developers. 18Because we want to enable as many people as possible to play with our code. So that you can start trusting it, the code not the developers.
19 19
20In order to allow you to inspect the code and analyze the traffic it generates between client and server, we had to provide an easy way to locally deploy the whole service. 20In order to allow you to inspect the code and analyze the traffic it generates between client and server, we had to provide an easy way to locally deploy the whole service.
21 21
22Feel free to host on your machine a web service identical to [Clipperz online password manager][home]. You can choose among **multiple backends** (PHP/MySQL, Python/AppEngine, …) or you can [contribute][CA] your own. 22Feel free to host on your machine a web service identical to [Clipperz online password manager][home]. You can choose among **multiple backends** (PHP/MySQL, Python/AppEngine, …) or you can [contribute][CA] your own.
23 23
24Whatever is your motivation, we would love to hear from you: [get in contact!][contact] 24Whatever is your motivation, we would love to hear from you: [get in contact!][contact]
25 25
26[CA]: http://www.clipperz.com/open_source/contributor_agreement 26[CA]: http://www.clipperz.com/open_source/contributor_agreement
27[contact]: http://www.clipperz.com/about/contacts 27[contact]: http://www.clipperz.com/about/contacts
28 28
29 29
30## Donations 30## Donations
31If you like what Clipperz is building, its openness and its view of cryptography as a powerful tool for liberty, then you may consider making a donation. 31If you like what Clipperz is building, its openness and its view of cryptography as a powerful tool for liberty, then you may consider making a donation.
32 32
33Our favorite payment method is clearly Bitcoin ([learn why here][why]), but you can also send your donation via credit card, Paypal or bank transfer. In all cases there will be no link between your real identity and your encrypted data stored on Clipperz. 33Our favorite payment method is clearly Bitcoin ([learn why here][why]), but you can also send your donation via credit card, Paypal or bank transfer. In all cases there will be no link between your real identity and your encrypted data stored on Clipperz.
34 34
35**To make your donation visit [this page][donations]. Thanks!** 35**To make your donation visit [this page][donations]. Thanks!**
36 36
37[why]: http://www.clipperz.com/pricing/why_bitcoin 37[why]: http://www.clipperz.com/pricing/why_bitcoin
38[donations]: http://www.clipperz.com/donations 38[donations]: http://www.clipperz.com/donations
39 39
40 40
41## License 41## License
42ALL the code included in this project, if not otherwise stated, is released with the [AGPL v3][agpl] license (see `LICENSE.txt`), and all rights are reserved to Clipperz Srl. For any use not allowed by the AGPL license, please [contact us][contact] to inquire about licensing options for commercial applications. 42ALL the code included in this project, if not otherwise stated, is released with the [AGPL v3][agpl] license (see `LICENSE.txt`), and all rights are reserved to Clipperz Srl. For any use not allowed by the AGPL license, please [contact us][contact] to inquire about licensing options for commercial applications.
43 43
44[agpl]: http://www.gnu.org/licenses/agpl.html 44[agpl]: http://www.gnu.org/licenses/agpl.html
45 45
46 46
47## Warnings 47## Warnings
48Please note that the open source version of Clipperz Password Manager may not be suitable for mass deployments, depending on how robust is the backend you select. As an example, the current PHP backend lacks several critical capabilities such as bot protection and concurrent sessions management. 48Please note that the open source version of Clipperz Password Manager may not be suitable for mass deployments, depending on how robust is the backend you select. As an example, the current PHP backend lacks several critical capabilities such as bot protection and concurrent sessions management.
49 49
50## Contributions 50## Contributions
51Your contributions to Clipperz are very welcome! In order to avoid jeopardizing the ownership of the code base, we will require every developer to sign the Clipperz [Contributor Agreement][CA] 51Your contributions to Clipperz are very welcome! In order to avoid jeopardizing the ownership of the code base, we will require every developer to sign the Clipperz [Contributor Agreement][CA]
52 52
53This enables a single entity to represent the aggregated code base and gives the community flexibility to act as a whole to changing situations. 53This enables a single entity to represent the aggregated code base and gives the community flexibility to act as a whole to changing situations.
54 54
55The CA establishes a joint copyright assignment in which the contributor retains copyright ownership while also granting those rights to Clipperz Srl. With the CA in place, the aggregated code base within any Clipperz open source project is protected by both the distribution license and copyright law. 55The CA establishes a joint copyright assignment in which the contributor retains copyright ownership while also granting those rights to Clipperz Srl. With the CA in place, the aggregated code base within any Clipperz open source project is protected by both the distribution license and copyright law.
56 56
57Please [download][CA] and review the Contributor Agreement for a complete understanding of its terms and conditions. You may send your signed and completed CA to Clipperz by scanning your completed form and emailing the image or by fax. Please retain a copy for your records. **Thanks!** 57Please [download][CA] and review the Contributor Agreement for a complete understanding of its terms and conditions. You may send your signed and completed CA to Clipperz by scanning your completed form and emailing the image or by fax. Please retain a copy for your records. **Thanks!**
58 58
59 59
60## Building 60## Building
61In order to build the deployable version, you need to invoke the following command: 61In order to build the deployable version, you need to invoke the following command:
62 62
63 git clone git@github.com:clipperz/password-manager.git 63 git clone git@github.com:clipperz/password-manager.git
64 cd password-manager 64 cd password-manager
65 ./scripts/build install --backends php python --frontends beta gamma 65 ./scripts/build install --backends php python --frontends beta gamma
66 66
67The output will be available in the `target` folder, with a separate folder for each backend (currently the available options are `php` and `python`). 67The output will be available in the `target` folder, with a separate folder for each backend (currently the available options are `php` and `python`).
68The script, invoked with these parameters, will build both the full version (`install` -> index.html) and the debug version (index_debug.html) of the specified frontends. 68The script, invoked with these parameters, will build both the full version (`install` -> index.html) and the debug version (index_debug.html) of the specified frontends.
69 69
70Besides PHP and Python, more backends are in the works, most notably a node.js version. 70Besides PHP and Python, more backends are in the works, most notably a node.js version.
71 71
72 72
73### Developing 73### Developing
74To support the development of the application, a few extra tools have been built, the most useful one being `dev-proxy`. 74To support the development of the application, a few extra tools have been built, the most useful one being `dev-proxy`.
75This script, located in `scripts/dev-proxy`, is invoked without any parameters (to simplify daily usage) and all its configurations are hard coded into the actual code it executes: `scripts/proxy/main.py`. 75This script, located in `scripts/dev-proxy`, is invoked without any parameters (to simplify daily usage) and all its configurations are hard coded into the actual code it executes: `scripts/proxy/main.py`.
76 76
77The aim of this proxy is to mask the actual location of frontend JS files from the actual backend handling requests. 77The aim of this proxy is to mask the actual location of frontend JS files from the actual backend handling requests.
78 78
79When executed, this script will start listening on localhost:8888. 79When executed, this script will start listening on localhost:8888.
80 80
81All 'backend' requests (whose path starts with either `/json` or `/dump`) will be forwarded to the actual backend, that is configured as a `ReverseProxyResource` (in the current code: `proxy.ReverseProxyResource('localhost', 8084, '/java-backend')`). 81All 'backend' requests (whose path starts with either `/json` or `/dump`) will be forwarded to the actual backend, that is configured as a `ReverseProxyResource` (in the current code: `proxy.ReverseProxyResource('localhost', 8084, '/java-backend')`).
82All other requests (html files, Javascript code, CSS stylesheets and other resources) will be handled by reading the resource from the filesystem; the proxy is aware of the layout of the project, so it will be able to locate the right resource in the right place. 82All other requests (html files, Javascript code, CSS stylesheets and other resources) will be handled by reading the resource from the filesystem; the proxy is aware of the layout of the project, so it will be able to locate the right resource in the right place.
83 83
84The only file that needs to be `build`, and not read directly from the file system, is the `index.html` file. 84The only file that needs to be `build`, and not read directly from the file system, is the `index.html` file.
85 85
86In order to build this file, the following command should be executed: 86In order to build this file, the following command should be executed:
87 87
88 ./scripts/build --frontends beta gamma gamma.mobile --backends dev 88 ./scripts/build --frontends beta gamma gamma.mobile --backends dev
89 89
90 90
91Once the index.html files have been built (one for each frontend) and a backend is running and has been correctly configured in the proxy script, it is possible to access the different versions of the application at the following URLs: 91Once the index.html files have been built (one for each frontend) and a backend is running and has been correctly configured in the proxy script, it is possible to access the different versions of the application at the following URLs:
92 92
93- `http://localhost:8888/beta/index.html` 93- `http://localhost:8888/beta/index.html`
94- `http://localhost:8888/gamma/index.html` 94- `http://localhost:8888/gamma/index.html`
95- `http://localhost:8888/gamma/index.mobile.html` 95- `http://localhost:8888/gamma/index.mobile.html`
96 96
97 97
98## Installing 98## Installing
99 99
100### PHP + MySQL backend 100### PHP + MySQL backend
101 101
102* **PHP** 102* **PHP**
103 Once the project has been successfully build, the application needs to be moved in a location where the web server can run it. Everything that is needed is located into `target/php`. 103 Once the project has been successfully build, the application needs to be moved in a location where the web server can run it. Everything that is needed is located into `target/php`.
104 104
105* **MySQL** 105* **MySQL**
106 The application needs a simple MySQL database; to configure all the credentials to access the previously allocated DB, edit the file found in `php/configuration.php`. You need to edit the file actually used by the web server; this will usually be the one moved into the right place in the previous step. 106 The application needs a simple MySQL database; to configure all the credentials to access the previously allocated DB, edit the file found in `php/configuration.php`. You need to edit the file actually used by the web server; this will usually be the one moved into the right place in the previous step.
107 Once the application is in place, and the DB credentials have been configured, you should initialize the DB itself; in order to do so, just point your browser at the following url: `http://<host>/<path>/php/setup/index.php`. 107 Once the application is in place, and the DB credentials have been configured, you should initialize the DB itself; in order to do so, just point your browser at the following url: `http://<host>/<path>/php/setup/index.php`.
108 Here you will find the standard [POG][pog] setup page: it should be enough to click the "POG me up!" button at the bottom of the page, and then the "Process" button on the next page. 108 Here you will find the standard [POG][pog] setup page: it should be enough to click the "POG me up!" button at the bottom of the page, and then the "Process" button on the next page.
109 The POG interface will allow also a very basic access to the DB data that may be useful to check that the application is actually writing something on the DB (even if you will not be able to make much sense out of the data you will see, as they are all encrypted!) 109 The POG interface will allow also a very basic access to the DB data that may be useful to check that the application is actually writing something on the DB (even if you will not be able to make much sense out of the data you will see, as they are all encrypted!)
110 More information about building the PHP backend may be found in the `doc/install.php.txt` file. 110 More information about building the PHP backend may be found in the `doc/install.php.txt` file.
111 111
112 But if you have setup a $configuration['setup_password'] in target/php/configuration.php then a page with a textfield and a "Submit" link will appear.
113 Just input your $configuration['setup_password'] value and click on "Submit" so [POG][pog] setup page will appear.
112 114
113## Disclaimer 115## Disclaimer
114 116
115This application has not been fully tested, so there may be still problems due to the new build script or to the new repository structure. So, for the moment, **use it at your own risk!** 117This application has not been fully tested, so there may be still problems due to the new build script or to the new repository structure. So, for the moment, **use it at your own risk!**
116 118
117 119
118[pog]: http://www.phpobjectgenerator.com/ \ No newline at end of file 120[pog]: http://www.phpobjectgenerator.com/