summaryrefslogtreecommitdiff
authorGiulio Cesare Solaroli <giulio.cesare@clipperz.com>2013-04-26 09:47:45 (UTC)
committer Giulio Cesare Solaroli <giulio.cesare@clipperz.com>2013-04-26 09:47:45 (UTC)
commit6336f032985eb14a21fd089d322002210095a0a7 (patch) (unidiff)
tree157ac3be4b0f89f7cec2d1f8cfedfd14387b417e
parent108dd23db8fdc9512446be708d2694f3050b1d8f (diff)
downloadclipperz-6336f032985eb14a21fd089d322002210095a0a7.zip
clipperz-6336f032985eb14a21fd089d322002210095a0a7.tar.gz
clipperz-6336f032985eb14a21fd089d322002210095a0a7.tar.bz2
Updated README
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index e20082c..aabb00e 100644
--- a/README.md
+++ b/README.md
@@ -1,84 +1,93 @@
1# ![Clipperz icon][icon] CLIPPERZ - Online Password Manager 1# ![Clipperz icon][icon] CLIPPERZ - Online Password Manager
2 2
3[icon]: ./Icon.png
3 4
4##What does Clipperz do? 5##What does Clipperz do?
5 6
6Clipperz is an online vault where you can store confidential data without worrying about security. It can be used to save and manage passwords, private notes, burglar alarm codes, credit and debit card details, PINs, software keys, … 7Clipperz is an online vault where you can store confidential data without worrying about security. It can be used to save and manage passwords, private notes, burglar alarm codes, credit and debit card details, PINs, software keys, …
7Since passwords are the most common type of private information that you need to protect, we have added a great deal of functionality to make Clipperz a great [online password manager][home] thus solving the “password fatigue” problem. 8Since passwords are the most common type of private information that you need to protect, we have added a great deal of functionality to make Clipperz a great [online password manager][home] thus solving the “password fatigue” problem.
8 9
9**Clipperz makes the Internet the most convenient and safe place to keep you most precious and sensitive data.** 10**Clipperz makes the Internet the most convenient and safe place to keep you most precious and sensitive data.**
10 11
11Read more on the [Clipperz website][home]. 12Read more on the [Clipperz website][home].
12 13
13[home]: http://www.clipperz.com 14[home]: http://www.clipperz.com
14 15
15## Why an open source version 16## Why an open source version
16 17
17Because 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.
18 19
19In 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.
20 21
21Feel free to host on your machine a web service identical to [Clipperz online password manager][clipperz]. 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.
22 23
23Whatever 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]
24 25
25[CA]: http://www.clipperz.com/open_source/contributor_agreement 26[CA]: http://www.clipperz.com/open_source/contributor_agreement
26[contact]: http://www.clipperz.com/about/contacts 27[contact]: http://www.clipperz.com/about/contacts
27 28
29
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.
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.
34
35**To make your donation visit [this page][donations]. Thanks!**
36
37[why]: http://www.clipperz.com/pricing/why_bitcoin
38[donations]: http://www.clipperz.com/donations
39
40
28## License 41## License
29ALL 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.
30 43
31[agpl]: http://www.gnu.org/licenses/agpl.html 44[agpl]: http://www.gnu.org/licenses/agpl.html
32 45
33 46
34## Warnings 47## Warnings
35Please 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.
36 49
37## Contributions 50## Contributions
38
39Your 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]
40 52
41This 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.
42 54
43The 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.
44 56
45Please [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!**
46 58
47 59
48## Building 60## Building
49
50In 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:
51 62
52 git clone git@github.com:clipperz/password-manager.git 63 git clone git@github.com:clipperz/password-manager.git
53 cd password-manager 64 cd password-manager
54 ./scripts/build install --backends php python --frontends beta gamma 65 ./scripts/build install --backends php python --frontends beta gamma
55 66
56The 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`).
57The 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.
58 69
59Besides 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.
60 71
61 72
62## Installing 73## Installing
63 74
64### PHP + MySQL backend 75### PHP + MySQL backend
65 76
66* **PHP** 77* **PHP**
67 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`. 78 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`.
68 79
69* **MySQL** 80* **MySQL**
70 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. 81 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.
71 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`. 82 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`.
72 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. 83 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.
73 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!) 84 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!)
74 More information about building the PHP backend may be found in the `doc/install.php.txt` file. 85 More information about building the PHP backend may be found in the `doc/install.php.txt` file.
75 86
76 87
77## Disclaimer 88## Disclaimer
78 89
79The resulting application has not been fully tested, so there may be still problems due to the new build script or some other changes that were done due to the new repository structure. So, for the moment, **use it at your own risk!** 90The resulting application has not been fully tested, so there may be still problems due to the new build script or some other changes that were done due to the new repository structure. So, for the moment, **use it at your own risk!**
80 91
81[icon]: http://0.gravatar.com/avatar/2a9fae49ced80a42830a206f88ea1022?size=100
82[clipperz]: http://www.clipperz.com
83 92
84[pog]: http://www.phpobjectgenerator.com/ \ No newline at end of file 93[pog]: http://www.phpobjectgenerator.com/ \ No newline at end of file