summaryrefslogtreecommitdiff
path: root/README.md
authorClipperz <info@clipperz.com>2013-01-31 13:42:04 (UTC)
committer Clipperz <info@clipperz.com>2013-01-31 13:42:04 (UTC)
commit07d0357beef5d9328a2dd8d07ad7b39c87ac55e4 (patch) (unidiff)
treef7a4aed8848302db153c2a211f8e58b944eb4c5b /README.md
parent767a3dcf48b6ac911c088af5dd7738a728eb6b99 (diff)
downloadclipperz-07d0357beef5d9328a2dd8d07ad7b39c87ac55e4.zip
clipperz-07d0357beef5d9328a2dd8d07ad7b39c87ac55e4.tar.gz
clipperz-07d0357beef5d9328a2dd8d07ad7b39c87ac55e4.tar.bz2
Updated Copyright claims
- updated reference dates; - removed reference to Community Edition; - normalized logging using Clipperz.log[Warn|Error|Debug]
Diffstat (limited to 'README.md') (more/less context) (ignore whitespace changes)
-rw-r--r--README.md45
1 files changed, 16 insertions, 29 deletions
diff --git a/README.md b/README.md
index 96b73a5..f9ad766 100644
--- a/README.md
+++ b/README.md
@@ -1,91 +1,78 @@
1# ![Clipperz icon][icon] CLIPPERZ COMMUNITY EDITION - Online Password Manager 1# ![Clipperz icon][icon] CLIPPERZ - Online Password Manager
2 2
3 3
4[Clipperz Community Edition][CE] allows you to host on your own server a web service identical to [Clipperz online password manager][clipperz]. It supports multiple backends (PHP/MySQL, Python/AppEngine, …) and you can contribute your own. 4##What does Clipperz do?
5 5
6ALL the code included in this project, if not otherwise stated, is released with the **AGPL v.3 license** (see `LICENSE.txt`), and all rights are reserved to Clipperz Srl. 6You can think of Clipperz as an online vault where you can store any sort of 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 the best online password manager available thus solving the “password fatigue” problem.
7 8
8For any use not allowed by the AGPL license, please [contact us][contact] to inquire about licensing options for commercial applications. 9**Clipperz makes the Internet the most convenient and safe place to keep you most precious and sensitive data.**
9 10
11Read more on the [Clipperz website][clipperz].
10 12
11## Why a Community Edition 13## Why an open source version
12 14
13But why would you prefer running Clipperz Community Edition from your own server instead of using the free and anonymous online service provided by its developers? 15Because 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.
14 16
15* “Clipperz security architecture is great, but I prefer to store my data on my hardware. I just feel better this way!” 17In 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.
16* “Clipperz is cool, but it would be even cooler it it had a Scala backend. I'm going to write it!"
17* “I would like to modify the look & feel of Clipperz and embed this powerful password manager within my family intranet.”
18* “Clipperz works nicely, but I would love to play with the source code in order to improve feature X and add new features Y and Z.”
19* …
20 18
21Whatever is your motivation, we would love to hear from you about how and where you use Clipperz Community Edition. [Get in contact!][contact] 19So, feel free to host on your own server a web service identical to [Clipperz online password manager][clipperz]. You can choose among multiple backends (PHP/MySQL, Python/AppEngine, …) and you can contribute your own.
22 20
21Whatever is your motivation, we would love to hear from you: [get in contact!][contact]
23 22
24## Warnings 23## License
25 24ALL the code included in this project, if not otherwise stated, is released with the **AGPL v.3 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.
26Please note that Clipperz Community Edition may not be suitable for mass deployments, depending on how robust is the backend you select.
27
28As an example, the current PHP backend lacks several critical capabilities such as bot protection and cuncurrent sessions management.
29
30
31## Community Edition vs Workgroup Edition
32
33This Community Edition is aimed to **individual users**, but you may be interested to know that we are working on a **Workgroup Edition** targeting organizations that need a
34password manager for their workforce (creating and managing employees accounts, defining groups and sharing policies, ...).
35
36The Workgroup Edition development is quite challenging and, while the overall design is already in place, it will still require a fairly large amount of resources for analysis and implementation.
37
38If your organization is interested in such edition, you can subscribe a "pledge" to sustain its development in exchange for a very generous user license with unlimited upgrades and other benefits. Again, [get in contact][contact]!
39 25
26## Warnings
27Please note that the open source version of Clipperz 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 cuncurrent sessions management.
40 28
41## Contributions 29## Contributions
42 30
43Your contributions to Clipperz Community Edition 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] 31Your 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]
44 32
45This enables a single entity to represent the aggregated code base and gives the community flexibility to act as a whole to changing situations. 33This enables a single entity to represent the aggregated code base and gives the community flexibility to act as a whole to changing situations.
46 34
47The 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. 35The 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.
48 36
49Please [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!** 37Please [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!**
50 38
51 39
52## Building 40## Building
53 41
54In order to build the deployable version, you need to invoke the following command: 42In order to build the deployable version, you need to invoke the following command:
55 43
56 ./scripts/build clean install debug --frontends beta --backends php 44 ./scripts/build clean install debug --frontends beta --backends php
57 45
58The output will be available in the `target` folder, with a separate folder for each build backend (initially this will be just a `php` folder). 46The output will be available in the `target` folder, with a separate folder for each build backend (initially this will be just a `php` folder).
59The script, invoked with these parameters, will build both the full version (`install` -> index.html) and the debug version (index_debug.html) of the /beta frontend using the PHP backend. 47The script, invoked with these parameters, will build both the full version (`install` -> index.html) and the debug version (index_debug.html) of the /beta frontend using the PHP backend.
60 48
61At the moment this is the only combination that works, but this script will be gradually extended to be able to build also the [/gamma frontend][gamma] (whose code is already in the repository) and possibly also other backends (Python AppEngine being the very first candidate, and a Javascript version per node.js another interesting option) 49At the moment this is the only combination that works, but this script will be gradually extended to be able to build also the [/gamma frontend][gamma] (whose code is already in the repository) and possibly also other backends (Python AppEngine being the very first candidate, and a Javascript version per node.js another interesting option)
62 50
63 51
64## Installing 52## Installing
65 53
66### PHP + MySQL backend 54### PHP + MySQL backend
67 55
68At the moment the only backend that the build script can successfully create is the PHP + MySQL one. 56At the moment the only backend that the build script can successfully create is the PHP + MySQL one.
69 57
70#### PHP 58#### PHP
71Once 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`. 59Once 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`.
72 60
73#### MySQL 61#### MySQL
74The 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. 62The 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.
75Once 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`. 63Once 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`.
76Here 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. 64Here 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.
77The 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!) 65The 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!)
78 66
79More information about building the PHP backend may be found in the `doc/install.php.txt` file. 67More information about building the PHP backend may be found in the `doc/install.php.txt` file.
80 68
81 69
82## Disclaimer 70## Disclaimer
83 71
84The 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!** 72The 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!**
85 73
86[icon]: http://0.gravatar.com/avatar/2a9fae49ced80a42830a206f88ea1022?size=100 74[icon]: http://0.gravatar.com/avatar/2a9fae49ced80a42830a206f88ea1022?size=100
87[CE]: http://clipperz.com/open_source/clipperz_community_edition
88[clipperz]: http://www.clipperz.com 75[clipperz]: http://www.clipperz.com
89[contact]: http://clipperz.com/contact 76[contact]: http://clipperz.com/contact
90[CA]: http://www.clipperz.com/open_source/contributor_agreement 77[CA]: http://www.clipperz.com/open_source/contributor_agreement
91[pog]: http://www.phpobjectgenerator.com/ \ No newline at end of file 78[pog]: http://www.phpobjectgenerator.com/ \ No newline at end of file