X-Git-Url: https://git.p6c8.net/jirafeau.git/blobdiff_plain/23b5b908d7f23a3a2f5f2bdb6e3e616dee8bf2ca..279ccffd5d01338523606b1519ec44addcc2d7d3:/README.md?ds=sidebyside diff --git a/README.md b/README.md index e03c4df..76f60a2 100644 --- a/README.md +++ b/README.md @@ -38,14 +38,15 @@ Jirafeau project won't evolve to a file manager and will focus to keep a very fe ## Screenshots -- [Installation part 1](http://i.imgur.com/hmpT1eN.jpg) -- [Installation part 2](http://i.imgur.com/2e0UGKE.jpg) -- [Installation part 3](http://i.imgur.com/ofAjLXh.jpg) -- [Installation part 4](http://i.imgur.com/WXqnfqJ.jpg) -- [Upload 1](http://i.imgur.com/SBmSwzJ.jpg) -- [Upload 2](http://i.imgur.com/wzPkb1Z.jpg) -- [Upload 3](http://i.imgur.com/i6n95kv.jpg) -- [Upload 4](http://i.imgur.com/P2oS1MY.jpg) +- [Installation - Step 1](http://i.imgur.com/hmpT1eN.jpg) +- [Installation - Step 2](http://i.imgur.com/2e0UGKE.jpg) +- [Installation - Step 3](http://i.imgur.com/ofAjLXh.jpg) +- [Installation - Step 4](http://i.imgur.com/WXqnfqJ.jpg) +- [Upload - Step 1](http://i.imgur.com/SBmSwzJ.jpg) +- [Upload - Step 2](http://i.imgur.com/wzPkb1Z.jpg) +- [Upload - Progress](http://i.imgur.com/i6n95kv.jpg) +- [Upload - Confirmation page](http://i.imgur.com/P2oS1MY.jpg) +- [Admin Interface](http://i.imgur.com/nTdsVzn.png) ## Installation @@ -119,6 +120,29 @@ By activating this feature, you have to be aware of few things: In a next step, encryption will be made by the client (in javascript), see issue #10. +## License + +GNU Affero General Public License version 3 (AGPLv3). + +The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html. + +Please note: If you decide do make adaptions to the source code and run a service with these changes incorporated, +you are required to provide a link to the source code of your version in order to obey the AGPLv3 license. +To do so please add a link to the source (eg. a public Git repository or a download link) to the Terms of Service page. +Take a look at the FAQ to find out about how to change the ToS. + +PS: If you have fixed errors or added features, then please contribute to the project and send a merge request with these changes. + +## Contribution + +If you want to contribute to project, then take a look at the git repository: + +- https://gitlab.com/mojo42/Jirafeau + +and the Contribution Guidelines + +- https://gitlab.com/mojo42/Jirafeau/blob/master/CONTRIBUTING.md + ## FAQ ### Can I add a new language in Jirafeau? @@ -188,6 +212,14 @@ If you don't want to allow unlimited upload size, you can still setup a maximal Documentation of all default options are located in [lib/config.original.php](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/config.original.php). If you want to change an option, just edit your ```lib/config.local.php```. +### How can I change the Terms of Service? + +The license text on the "Terms of Service" page, which is shipped with the default installation, is based on the »[Open Source Initiative Terms of Service](https://opensource.org/ToS)«. + +To change this text simply copy the file [/lib/tos.original.txt](https://gitlab.com/mojo42/Jirafeau/blob/master/lib/tos.original.txt), rename it to ```/lib/tos.local.txt``` and adapt it to your own needs. + +If you update the installation, then only the ```tos.original.txt``` file may change eventually, not your ```tos.local.txt``` file. + ### How can I access the admin interface? Just go to ```/admin.php```. @@ -224,14 +256,6 @@ The original project seems not to be continued anymore and I prefer to add more Check [issues](https://gitlab.com/mojo42/Jirafeau/issues) to check open bugs and incoming new stuff. :) -### What is the Jirafeau's license? - -Jirafeau is licensed under [AGPLv3](https://gitlab.com/mojo42/Jirafeau/blob/master/COPYING). - -### How do I modify the TOS (terms of use)? - -Just edit ```tos.php``` and configure ```$org``` and ```$contact``` variables. - ### What about this file deduplication thing? Jirafeau uses a very simple file level deduplication for storage optimization.