tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-09-29 20:59:23 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8828 from open-sausages/pulls/4/docs-legacy-filenames

Browse Source 
DOCS Clarify file migration and mention known bug
This commit is contained in:
Guy Marriott 2019-02-27 10:37:39 +13:00 committed by GitHub
commit 3497c05a83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/en/02_Developer_Guides/14_Files/05_File_Migration.md
View File

@ -23,6 +23,9 @@ that previously visible assets remain visible to the public site.
If additional security or visibility rules should be applied to File dataobjects, then If additional security or visibility rules should be applied to File dataobjects, then
make sure to correctly extend `canView` via extensions. make sure to correctly extend `canView` via extensions.
*IMPORTANT*: There is a [known bug](https://github.com/silverstripe/silverstripe-versioned/issues/177)
which breaks existing direct links to asset URLs unless `legacy_filenames` is set to `true` (see below).
## Automatic migration ## Automatic migration
Migration can be invoked by either this task, or can be configured to automatically run during dev build Migration can be invoked by either this task, or can be configured to automatically run during dev build
@ -63,20 +66,22 @@ are incompatible with core file security.
## Support existing paths ## Support existing paths
Because the filesystem now uses the sha1 of file contents in order to version multiple versions under the same Because the filesystem now uses the hash of file contents in order to version multiple versions under the same
filename, the default storage paths in 4.0 will not be the same as in 3. filename, the default storage paths in 4.0 will not be the same as in 3.
Although it is not recommended, it is possible to configure the backend to omit this SHA1 url segment, Although it is not recommended, it is possible to configure the backend to omit this hash url segment,
meaning that file paths and urls will not be modified during the upgrade. meaning that file paths and urls will not be modified during the upgrade.
This configuration needs to be chosen before starting the file migration,
This is done by setting this config: and can't be changed after migration.
```yaml ```yaml
SilverStripe\Assets\Flysystem\FlysystemAssetStore: SilverStripe\Assets\Flysystem\FlysystemAssetStore:
legacy_filenames: true legacy_filenames: true
``` ```
Note that this will not allow you to utilise certain file versioning features in 4.0. This setting will still allow protected (draft) files.
It'll also keep track of changes to file metadata (e.g. title and description),
but won't keep track of replaced file contents.
## Migrating substantial number of files ## Migrating substantial number of files