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