X-Git-Url: https://git.p6c8.net/jirafeau_project.git/blobdiff_plain/d05d58ec8fd2f473e154bb3daf182117007f10a0..c147db2590b6add287eac571b1ce751be734b2ea:/README.md?ds=sidebyside diff --git a/README.md b/README.md index bbad047..bf7c38d 100644 --- a/README.md +++ b/README.md @@ -60,25 +60,36 @@ Note that ```lib/config.local.php``` is auto-generated during the installation. If you don't want to go through the installation wizard, you can just copy ```config.original.php``` to ```config.local.php``` and customize it. -## Update +## Upgrade -### General +### General procedure for all versions -1. Backup you Jirafeau installation +1. Backup your Jirafeau installation! 2. Block access to Jirafeau -3. Checkout new version using the [tagged release](https://gitlab.com/mojo42/Jirafeau/tags) +3. Checkout the new version with Git using the [tagged release](https://gitlab.com/mojo42/Jirafeau/tags) + * If you have installed Jirafeau just by uploading files on your server, you can download the desired version, overwrite/remove all files and chown/chmod files if needed. Keep a backup of your local configuration file tough. 4. With you browser, go to your Jirafeau root page -5. Follow installation wizard, it should propose you the same data folder -7. Go in you lib/config.local.php and lib/config.original.php to check new options +5. Follow the installation wizard, it should propose you the same data folder or even update automatically +7. Check your ```/lib/config.local.php``` and compare it with the ```/lib/config.original.php``` to see if new configuration items are available ### From version 1.0 to 1.1 -1. Add a rewrite rule in your web server configuration to rename file.php to f.php to make old url work again -2. Eventually change skin in »lib/config.local.php« to 'courgette' +1. The download URL changed + * Add a rewrite rule in your web server configuration to rename ```file.php``` to ```f.php``` to make older, still existing links work again +1. The default skin changed + * Optionally change the skin in ```lib/config.local.php``` to »courgette« -### From version 1.1 to 1.2.0 +### From version 1.2.0 to 2.0.0 -Nothing particular +1. The "Terms of Service" text file changed + * To reuse previous changes to the ToS, move the old ```/tos_text.php``` file to ```/lib/tos.local.txt``` and remove all HTML und PHP Tags, leaving a regular text file + +### Troubleshooting + +If you have some troubles, consider the following cases + +- Check your ```/lib/config.local.php``` file and compare it with ```/lib/config.original.php```, the configuration syntax or a parameter may have changed +- Check owner & permissions of your files ## Security @@ -120,6 +131,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? @@ -134,17 +168,7 @@ We would like to thank all anonymous contributors on weblate. :) ### How do I upgrade my Jirafeau? -If you have installed Jirafeau using git, it's pretty simple: just make a git pull and chown/chmod files who have the owner changed. - -If you have installed Jirafeau just by uploading files on your server, you can take the [last version](https://gitlab.com/mojo42/Jirafeau/repository/archive.zip), overwrite files and chown/chmod files if needed. - -After upgrading, you can compare your ```lib/config.local.php``` and ```lib/config.original.php``` to see if new configuration items are available. - -If you have some troubles: -- It should probably come from your ```lib/config.local.php``` (configuration syntax may have changed). Just compare it with ```lib/config.original.php``` -- Check owner/permissions of your files. - -Anyway you should off-course make a backup of your current installation before doing anything. :) +See upgrade instructions above. ### How can I limit upload access? @@ -189,6 +213,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```. @@ -225,14 +257,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. @@ -297,3 +321,13 @@ The very first version of Jirafeau after the fork of Jyraphe. - Default expiration date set to 'month' - New expiration date: 'quarter' - Small other fixes + +## Version 2.0.0 + +- ToS refactoring (see update notes !) +- You can now set a title to Jirafeau in options +- A lot of documentation improvements +- Code refactoring & bugfixes +- Add version to bash script +- A lot of documentation improvements +- Code refactoring & bug fixes