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