Translated using Weblate (Turkish)

[jirafeau_mojo42.git] / README.md

diff --git a/README.md b/README.md
index 461a3f9a11da982ed7f9eae17169b7c20bbefa43..37fdfc7593ab784bc0b3556503631f6317700593 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
 
 
 Welcome to the official Jirafeau project, an [Open-Source software](https://en.wikipedia.org/wiki/Open-source_software).
 

-Jirafeau is a project permitting a "one-click-filesharing", which makes it possible to upload a file in a simple way and give an unique link to it.
+Jirafeau allows your to "one-click-filesharing". It makes possible to upload a file in a simple way and give an unique link to it.

 
 

-A demonstration of the latest version is available on [jirafeau.net](http://jirafeau.net/).
+A demonstration of the latest version is available on [jirafeau.net](https://jirafeau.net/).

 
 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
 
 
 ![Screenshot1](http://i.imgur.com/TPjh48P.png)
 


@@ -25,7 +25,7 @@ Next Release [![Build Status Next Release](https://gitlab.com/mojo42/Jirafeau/ba
 - Shortened URLs using base 64 encoding
 - Maximal upload size configurable
 - NO database, only use basic PHP
 - Shortened URLs using base 64 encoding
 - Maximal upload size configurable
 - NO database, only use basic PHP

-- Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk: :hu: :cn: :gr: :ru: :es: :tk: :flag_tr:
+- Simple language support with a lot of langages (help us on [weblate](https://hosted.weblate.org/engage/jirafeau/)!)

 - File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization (does store duplicate files only once, but generate multiple links)
 - Optional data encryption
 - Small administration interface
 - File level [Deduplication](http://en.wikipedia.org/wiki/Data_deduplication) for storage optimization (does store duplicate files only once, but generate multiple links)
 - Optional data encryption
 - Small administration interface


@@ -55,52 +55,24 @@ Jirafeau project won't evolve to a file manager and will focus to keep a very fe
 
 ## Installation
 
 
 ## Installation
 

+This shows how to install Jirafeau by your own, it's quite simple but you can
+also use a [docker image](https://hub.docker.com/r/mojo42/jirafeau/) or build
+it yourself. Check [docker folder](docker/README.md) for more informations.
+

 System requirements:
 - PHP >= 5.6
 - Optional, but recommended: Git >= 2.7
 - No database required, no mail required
 
 Installation steps:
 System requirements:
 - PHP >= 5.6
 - Optional, but recommended: Git >= 2.7
 - No database required, no mail required
 
 Installation steps:

-- Clone the [repository](https://gitlab.com/mojo42/Jirafeau/) or download the latest ([release](https://gitlab.com/mojo42/Jirafeau/tags) from GitLab onto your webserver
+- Clone the [repository](https://gitlab.com/mojo42/Jirafeau/) or download the latest [release](https://gitlab.com/mojo42/Jirafeau/tags) from GitLab onto your webserver

 - Set owner & group according to your webserver
 - A) Setup with the installation wizard (web):
   - Open your browser and go to your installed location, eg. ```https://example.com/jirafeau/```
   - The script will redirect to you to a minimal installation wizard to set up all required options
   - All optional parameters may be set in ```lib/config.local.php```, take a look at ```lib/config.original.php``` to see all default values
 - B) Setup without the installation wizard (cli):
 - Set owner & group according to your webserver
 - A) Setup with the installation wizard (web):
   - Open your browser and go to your installed location, eg. ```https://example.com/jirafeau/```
   - The script will redirect to you to a minimal installation wizard to set up all required options
   - All optional parameters may be set in ```lib/config.local.php```, take a look at ```lib/config.original.php``` to see all default values
 - B) Setup without the installation wizard (cli):

-  - Just copy ```config.original.php``` to ```config.local.php``` and customize it
-
-## Upgrade
-
-### General procedure for all versions
-
-1. Backup your Jirafeau installation!
-2. Block access to Jirafeau
-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 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. 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 theme changed
-   * Optionally change the theme in ```lib/config.local.php``` to »courgette«
-
-### From version 1.2.0 to 2.0.0
-
-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
-
-### From version 2.0.0 to 3.0.0
-
-1. No special change to upgrade to 3.0.0
-
-### From version 2.0.0 to 3.1.0
-
-1. No special change to upgrade to 3.1.0
+  - Just copy ```lib/config.original.php``` to ```lib/config.local.php``` and customize it

 
 ### Troubleshooting
 
 
 ### Troubleshooting
 


@@ -111,7 +83,7 @@ If you have some troubles, consider the following cases
 
 ## Security
 
 
 ## Security
 

-```var``` directory contain all files and links. It is randomly named to limit access but you may add better protection to prevent un-authorized access to it.
+```var``` directory contains all files and links. It is randomly named to limit access but you may add better protection to prevent un-authorized access to it.

 You have several options:
 - Configure a ```.htaccess```
 - Move var folder to a place on your server which can't be directly accessed
 You have several options:
 - Configure a ```.htaccess```
 - Move var folder to a place on your server which can't be directly accessed


@@ -130,13 +102,22 @@ location ~ /var-.* {
 }
 ```
 
 }
 ```
 

+If you are using lighttpd, you can deny access to ```var``` folder in your configuration:
+
+```
+$HTTP["url"] =~ "^/var-*" {
+         url.access-deny = ("")
+}
+```
+

 You should also remove un-necessessary write access once the installation is done (ex: configuration file).
 You should also remove un-necessessary write access once the installation is done (ex: configuration file).

-An other obvious basic security is to let access users to the site by HTTPS.
+An other obvious basic security is to let access users to the site by HTTPS (make sure `web_root` in you `config.local.php` is set with https).

 
 ## Server side encryption
 
 Data encryption can be activated in options. This feature makes the server encrypt data and send the decryt key to the user (inside download URL).
 The decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content.
 
 ## Server side encryption
 
 Data encryption can be activated in options. This feature makes the server encrypt data and send the decryt key to the user (inside download URL).
 The decrypt key is not stored on the server so if you loose an url, you won't be able to retrieve file content.

+Encryption is configured to use AES256 in OFB mode.

 In case of security troubles on the server, attacker won't be able to access files.
 
 By activating this feature, you have to be aware of few things:
 In case of security troubles on the server, attacker won't be able to access files.
 
 By activating this feature, you have to be aware of few things:


@@ -155,13 +136,13 @@ GNU Affero General Public License v3 (AGPL-3.0).
 
 The GNU Affero General Public License can be found at https://www.gnu.org/licenses/agpl.html.
 
 
 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, 
+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 AGPL-3.0 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.
 you are required to provide a link to the source code of your version in order to obey the AGPL-3.0 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:
 ## Contribution
 
 If you want to contribute to project, then take a look at the git repository:


@@ -178,15 +159,15 @@ and the Contribution Guidelines
 
 Of course ! Translations are easy to make and no technical knowledge is required.
 
 
 Of course ! Translations are easy to make and no technical knowledge is required.
 

-Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/projects/jirafeau/master/).
+Simply go to [Jirafeau's Weblate](https://hosted.weblate.org/engage/jirafeau/).

 
 If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.
 
 
 If you want to add a new language in the list, feel free to contact us or leave a comment in ticket #9.
 

-We would like to thank all anonymous contributors on weblate. :)
+Thanks to all contributors ! :)

 
 ### How do I upgrade my Jirafeau?
 
 
 ### How do I upgrade my Jirafeau?
 

-See upgrade instructions above.
+See change log and upgrade procedure in [CHANGELOG.md](https://gitlab.com/mojo42/Jirafeau/blob/master/CHANGELOG.md).

 
 ### How can I limit upload access?
 
 
 ### How can I limit upload access?
 


@@ -230,7 +211,7 @@ Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jiraf
 If your browser supports HTML5 file API, you can send files as big as you want.
 
 For browsers who does not support HTML5 file API, the limitation come from PHP configuration.
 If your browser supports HTML5 file API, you can send files as big as you want.
 
 For browsers who does not support HTML5 file API, the limitation come from PHP configuration.

-You have to set [post_max_size](https://php.net/manual/en/ini.core.php#ini.post-max-size) and [upload_max_filesize](https://php.net/manual/en/ini.core.php#ini.upload-max-filesize) in your php configuration.
+You have to set [post_max_size](https://php.net/manual/en/ini.core.php#ini.post-max-size) and [upload_max_filesize](https://php.net/manual/en/ini.core.php#ini.upload-max-filesize) in your php configuration. Note that Nginx setups may requiere to configure `client_max_body_size`.

 
 If you don't want to allow unlimited upload size, you can still setup a maximal file size in Jirafeau's setting (see ```maximal_upload_size``` in your configuration)
 
 
 If you don't want to allow unlimited upload size, you can still setup a maximal file size in Jirafeau's setting (see ```maximal_upload_size``` in your configuration)
 


@@ -293,9 +274,11 @@ If someone use his/her delete link or an admin cleans expired links, this will d
 
 When the counter falls to zero, the file is destroyed.
 
 
 When the counter falls to zero, the file is destroyed.
 

+In order to know if a newly uploaded file already exist, Jirafeau will hash the file using md5 by default but other methods are available (see `file_hash` documentation in `lib/config.original.php`).
+

 ### What is the difference between "delete link" and "delete file and links" in admin interface?
 
 ### What is the difference between "delete link" and "delete file and links" in admin interface?
 

-As explained in the previous question, files with the same md5 hash are not duplicated and a reference counter stores the number of links pointing to a single file.
+As explained in the previous question, files with the same hash are not duplicated and a reference counter stores the number of links pointing to a single file.

 So:
 - The button "delete link" will delete the reference to the file but might not destroy the file.
 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.
 So:
 - The button "delete link" will delete the reference to the file but might not destroy the file.
 - The button "delete file and links" will delete all references pointing to the file and will destroy the file.


@@ -303,79 +286,3 @@ So:
 ### How to contact someone from Jirafeau?
 
 Feel free to create an issue if you found a bug.
 ### How to contact someone from Jirafeau?
 
 Feel free to create an issue if you found a bug.

-
-## Release notes
-
-### Version 1.0
-
-The very first version of Jirafeau after the fork of Jyraphe.
-
-- Security fix
-- Keep uploader's ip
-- Delete link for each upload
-- No more clear text password storage
-- Simple langage support
-- Add an admin interface
-- New Design
-- Add term of use
-- New path system to manage large number of files
-- New option to show a page at download time
-- Add option to activate or not preview mode
-
-### Version 1.1
-
-- New skins
-- Add optional server side encryption
-- Unlimited file size upload using HTML5 file API
-- Show speed and estimated time during upload
-- A lot of fixes
-- A lot of new langages
-- Small API to upload files
-- Limit access to Jirafeau using IP, mask, passwords
-- Manage (some) proxy headers
-- Configure your maximal upload size
-- Configure file's lifetime durations
-- Preview URL
-- Get Jirafeau's version in admin interface
-
-## Version 1.2.0
-
-- Link on API page to generate bash script
-- More informative error codes for API
-- Security Fix: Prevent authentication bypass for admin interface
-- CLI script to remove expired files automatically with a cronjob
-- SHA-256 hash the admin password
-- New theme "elegantish"
-- Fix for JavaScript MIME-Type, prevents blocking the resource on some servers
-- Show download link for a file in admin interface
-- Default time for expiration (set to 'month' by default)
-- New expiration time: 'quarter'
-- A lof of translation contributions
-- Code cleanups
-
-## Version 2.0.0
-
-- Various documentation improvements
-- Simplify automatic generation of local configuration file
-- Set a custom title
-- Bash Script: Enhanced help, show version, return link to web view as well
-- »Terms of Service« refactored - Enable admin to overwrite the ToS, without changing existing source code → breaking, see upgrade notes
-
-## Version 3.0.0
-
-- Remove XHTML doctype, support HTML5 only → breaking change for older browsers
-- Remove redundant code
-- Remove baseurl usage and set absolute links instead, which for example fixes SSL issues
-- Extend contribution guide
-- Switch to PSR-2 code style (fix line endings, indentations, whitespaces, etc)
-- Declare system requirements
-- Catch API errors in upload form
-- Allow clients to upload files depending on IP or password
-- Set UTC as timezone to prevent date/time issues
-- Show readable date & time information
-- Fix UI glitches in admin panel and upload form
-
-## Version 3.1.0
-
-- Fix regression on user authentication (see #113)
-- Some cosmetic change