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/).
- 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:
+- Simple language support :gb: :fr: :de: :it: :nl: :ro: :sk: :hu: :cn: :gr: :ru: :es: :tk: :flag_tr: :flag_pt: :flag_br:
- 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
- Basic, adaptable »Terms Of Service« page
- Basic API
- Bash script to upload files via command line
-- Skins
+- Themes
Jirafeau is a fork of the original project [Jyraphe](http://home.gna.org/jyraphe/) based on the 0.5 (stable version) with a **lot** of modifications.
## 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:
-- 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/```
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«
+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
+### from version 2.0.0 to 3.4.1
-1. No special change to upgrade to 3.0.0
+There is nothing special to do to update from/to the following versions:
+- 2.0.0 -> 3.0.0
+- 3.0.0 -> 3.1.0
+- 3.1.0 -> 3.2.0
+- 3.2.0 -> 3.2.1
+- 3.2.1 -> 3.3.0
+- 3.3.0 -> 3.4.0
+- 3.4.0 -> 3.4.1
### Troubleshooting
}
```
+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).
-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
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.
-
+
## Contribution
If you want to contribute to project, then take a look at the git repository:
Anyway I would recommend you to use another web browser. :)
+### How can I change the theme?
+
+You may change the default theme to any of the existing ones or a custom.
+
+Open your ```lib/config.local.php``` and change setting in the »`style`« key to the name of any folder in the ```/media``` directory.
+
+Hint: To create a custom theme just copy the »courgette« folder and name your theme »custom« (this way it will be ignored by git and not overwritten during updates). You are invited to enhance the existing themes and send pull requests however.
+
### I found a bug, what should I do?
Feel free to open a bug in the [GitLab's issues](https://gitlab.com/mojo42/Jirafeau/issues).
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)
## Version 3.0.0
-- A lot of code cleaning
-- Replace all domain depended links
-- Better documentation
-- Convert UTC dates to clients timezone
-- Show readable date format
-- Multiple UI glitch fixes
-- Switch to PSR-2
-- Catch errors in upload form
-- Can now use IP _or_ password authentification
--
+- 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
+
+## Version 3.2.0
+
+- Update translations from Update translations from weblate
+- Better style
+- Fix regression on admin password setting
+
+## Version 3.2.1
+
+- fix download view after an upload
+
+## Version 3.3.0
+
+- Added Docker Support
+- Added a copy button next to links to copy URLs in clipboard
+- Now use a delete page to confirm file deletion (#136)
+- Fixed object ProgressEvent Error (#127)
+- Added configuration tips for web servers
+- More translations
+- Style fixes
+- Removed useless alias API support (some old toy)
+
+## Version 3.4.0
+
+- Add encryption support in bash script
+- Refactoring of lang system for simpler management
+- Removed installation step asking for language
+- Merged weblate contributions
+- Fixed some spelling issues
+
+## Version 3.4.1
+
+- Security fixes, thanks [Bishopfox Team](https://www.bishopfox.com/)
+- Translation fixes
+- Docker fix
+- Advertise javascript license for LibreJS compatibility
+- other minor fixes
git.p6c8.net / jirafeau_project.git / blobdiff