CHANGELOG.md

   1 # Note about upgrading
   2
   3 "in-place upgrade" refers to this general procedure:
   4
   5 1. Backup your Jirafeau installation!
   6 2. Block access to Jirafeau
   7 3. Checkout the new version with Git using the [tagged release](https://gitlab.com/mojo42/Jirafeau/tags)
   8    * 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.
   9 4. With you browser, go to your Jirafeau root page
  10 5. Follow the installation wizard, it should propose you the same data folder or even update automatically
  11 6. Check your `/lib/config.local.php` and compare it with the `/lib/config.original.php` to see if new configuration items are available. If a new item is missing in your `config.local.php`, this may trigger some errors as Jirafeau may expect to have them.
  12
  13
  14 # version 4.4.0
  15
  16 - Add docker options
  17 - Admin pannel can output informations for bug opening
  18 - Fixes for PHP 8
  19 - Fix autocomplete field for passwords
  20 - Fix file previewing
  21 - Disallow file preview for image/svg+xml files
  22 - Expiry after a fortnight (2 weeks)
  23 - Typo and spelling mistakes
  24 - Upgrade from 4.3.0: in-place upgrade
  25
  26 New configuration items:
  27 - `fortnight` value in `availabilities` array (default to `true`)
  28
  29 # version 4.3.0
  30
  31 - Fix various docker errors
  32 - Fix various upload errors
  33 - Add composer (useful for CI)
  34 - Code cleaning
  35 - Add option 'store_uploader_ip' to avoid uploaders ip logging
  36 - Upgrade from 4.2.0: in-place upgrade
  37
  38 New configuration items:
  39 - `store_uploader_ip` (default to `true`)
  40
  41 # version 4.2.0
  42
  43 - New file_hash option to eventually speed-up file identification process
  44 - one_time_download is now optional
  45 - Litespeed workaround for large files
  46 - Admin interface can compute data folder size
  47 - REUSE compliance test
  48 - multiple docker features: mcrypt support, daily cleanup, unprivileged user
  49 - Add upload password capability in script options
  50 - Various bugfixes around retries and error management
  51 - Automatically lower chunk size sent to server refusing large chunks
  52 - Romanian lang support and other various lang support
  53 - Upgrade from 4.1.1: in-place upgrade
  54
  55 # Version 4.1.1
  56
  57 - Fix lang sanity check
  58 - Upgrade from 4.1.0: in-place upgrade
  59
  60 # Version 4.1.0
  61
  62 - Fix upload password and allowed ip (#201)
  63 - Code refactorisation of IP checking
  64 - Fix expiration dates
  65 - Add better support for Accept-Language
  66 - Cosmetic fixes
  67 - More languages supported and language fixes
  68 - Upgrade from 4.0.0: in-place upgrade
  69
  70 # Version 4.0.0
  71
  72 - Removed plain-text password support for admin auth (breaking change).
  73 - Default folder sub-division to 8 characters (breaking change).
  74 - New option `upload_ip_nopassword` to allow a list of IP to access Jirafeau without password
  75 - Bugfix with LibreJS
  76 - Other minor bug fixes
  77 - More languages supported
  78
  79 ## Upgrade from 3.4.1 to 4.0.0
  80
  81 You may have to change your administrator password in your config file as admin password are only stored using sha256 (SHA2).
  82 To do so, edit `lib/config.local.php` and update `admin_password` option using `echo -n MyNewPassw0rd | sha256sum` command.
  83
  84 Subfolder division changed in Jirafeau storage. You can either start from a fresh `var-` folder or you need to migrate your data.
  85
  86 In order to migrate your existing data:
  87 1. Be sure to have a working backup of your Jirafeau instance and/or the rest of your hosting before any operation
  88 2. Go to `var-` folder
  89 3. Be sure you have read and write permissions on files and folders with your current user
  90 4. Run the following commands:
  91 ```bash
  92 # Migrate files folder
  93 find files -type f ! -name "*_count" | while read f; do bn="$(basename "$f")"; dst="files/${bn:0:8}/${bn:8:8}/${bn:16:8}/${bn:24:8}/"; mkdir -p "$dst"; mv "$f" "$dst" ; mv "${f}_count" "$dst"; done; find files -maxdepth 1 -type d -iname "?" -exec rm -rf {} \;
  94 # Migrate links folder
  95 find links -type f | while read link; do bn="$(basename "$link")"; mkdir "links/$bn"; mv "$link" "links/$bn/"; done; find links -maxdepth 1 -type d -iname "?" -exec rm -rf {} \;
  96 ```
  97
  98 # Version 3.4.1
  99
 100 - Security fixes, thanks [Bishopfox Team](https://www.bishopfox.com/)
 101 - Translation fixes
 102 - Docker fix
 103 - Advertise JavaScript license for LibreJS compatibility
 104 - other minor fixes
 105 - Upgrade from 3.4.0: in-place upgrade
 106
 107 # Version 3.4.0
 108
 109 - Add encryption support in bash script
 110 - Refactoring of lang system for simpler management
 111 - Removed installation step asking for language
 112 - Merged weblate contributions
 113 - Fixed some spelling issues
 114 - Upgrade from 3.3.0 : in-place upgrade
 115
 116 # Version 3.3.0
 117
 118 - Added Docker Support
 119 - Added a copy button next to links to copy URLs in clipboard
 120 - Now use a delete page to confirm file deletion (#136)
 121 - Fixed object ProgressEvent Error (#127)
 122 - Added configuration tips for web servers
 123 - More translations
 124 - Style fixes
 125 - Removed useless alias API support (some old toy)
 126 - Upgrade from 3.2.1 : in-place upgrade
 127
 128 # Version 3.2.1
 129
 130 - fix download view after an upload
 131 - Upgrade from 3.2.0 : in-place upgrade
 132
 133 # Version 3.2.0
 134
 135 - Update translations from Update translations from weblate
 136 - Better style
 137 - Fix regression on admin password setting
 138 - Upgrade from 3.1.0 : in-place upgrade
 139
 140 # Version 3.1.0
 141
 142 - Fix regression on user authentication (see #113)
 143 - Some cosmetic change
 144 - Upgrade from 3.0.0 : in-place upgrade
 145
 146 # Version 3.0.0
 147
 148 - Remove XHTML doctype, support HTML5 only → breaking change for older browsers
 149 - Remove redundant code
 150 - Remove baseurl usage and set absolute links instead, which for example fixes SSL issues
 151 - Extend contribution guide
 152 - Switch to PSR-2 code style (fix line endings, indentations, whitespaces, etc)
 153 - Declare system requirements
 154 - Catch API errors in upload form
 155 - Allow clients to upload files depending on IP or password
 156 - Set UTC as timezone to prevent date/time issues
 157 - Show readable date & time information
 158 - Fix UI glitches in admin panel and upload form
 159 - Upgrade from 2.0.0 : in-place upgrade
 160
 161 # Version 2.0.0
 162
 163 - Various documentation improvements
 164 - Simplify automatic generation of local configuration file
 165 - Set a custom title
 166 - Bash Script: Enhanced help, show version, return link to web view as well
 167 - »Terms of Service« refactored - Enable admin to overwrite the ToS, without changing existing source code → breaking, see upgrade notes
 168
 169 ## Upgrade from version 1.2.0 to 2.0.0
 170
 171 The "Terms of Service" text file changed.
 172 To reuse a custom version of your ToS, move your ```/tos_text.php``` file to ```/lib/tos.local.txt``` and remove all HTML und PHP Tags, leaving a regular text file.
 173
 174 # Version 1.2.0
 175
 176 - Link on API page to generate bash script
 177 - More informative error codes for API
 178 - Security Fix: Prevent authentication bypass for admin interface
 179 - CLI script to remove expired files automatically with a cron job
 180 - SHA-256 hash the admin password
 181 - New theme "elegantish"
 182 - Fix for JavaScript MIME-Type, prevents blocking the resource on some servers
 183 - Show download link for a file in admin interface
 184 - Default time for expiration (set to 'month' by default)
 185 - New expiration time: 'quarter'
 186 - A lot of translation contributions
 187 - Code cleanups
 188 - Upgrade from 1.1: in-place upgrade
 189
 190 # Version 1.1
 191
 192 - New skins
 193 - Add optional server side encryption
 194 - Unlimited file size upload using HTML5 file API
 195 - Show speed and estimated time during upload
 196 - A lot of fixes
 197 - A lot of new languages
 198 - Small API to upload files
 199 - Limit access to Jirafeau using IP, mask, passwords
 200 - Manage (some) proxy headers
 201 - Configure your maximal upload size
 202 - Configure file's lifetime durations
 203 - Preview URL
 204 - Get Jirafeau's version in admin interface
 205
 206 ### From version 1.0 to 1.1
 207
 208 - 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-
 209 - The default theme changed. Optionally change the theme in ```lib/config.local.php``` to "courgette"
 210
 211 ## Version 1.0
 212
 213 The very first version of Jirafeau after the fork of Jyraphe.
 214
 215 - Security fix
 216 - Keep uploader's ip
 217 - Delete link for each upload
 218 - No more clear text password storage
 219 - Simple language support
 220 - Add an admin interface
 221 - New Design
 222 - Add term of use
 223 - New path system to manage large number of files
 224 - New option to show a page at download time
 225 - Add option to activate or not preview mode