diff options
Diffstat (limited to 'doc/administration/uploads.md')
| -rw-r--r-- | doc/administration/uploads.md | 60 |
1 files changed, 16 insertions, 44 deletions
diff --git a/doc/administration/uploads.md b/doc/administration/uploads.md index 94e7bbe2cff..49af8358e29 100644 --- a/doc/administration/uploads.md +++ b/doc/administration/uploads.md @@ -8,46 +8,17 @@ info: To determine the technical writer assigned to the Stage/Group associated w Uploads represent all user data that may be sent to GitLab as a single file. As an example, avatars and notes' attachments are uploads. Uploads are integral to GitLab functionality, and therefore cannot be disabled. -## Upload parameters - -> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/issues/214785) in GitLab 13.5. -> - It's [deployed behind a feature flag](../user/feature_flags.md), enabled by default. -> - It's enabled on GitLab.com. -> - It's recommended for production use. -> - For GitLab self-managed instances, GitLab administrators can opt to disable it. **(CORE ONLY)** - -In 13.5 and later, upload parameters are passed [between Workhorse and GitLab Rails](../development/architecture.md#simplified-component-overview) differently than they -were before. - -This change is deployed behind a feature flag that is **enabled by default**. - -If you experience any issues with upload, -[GitLab administrators with access to the GitLab Rails console](feature_flags.md) -can opt to disable it. - -To enable it: - -```ruby -Feature.enable(:upload_middleware_jwt_params_handler) -``` - -To disable it: - -```ruby -Feature.disable(:upload_middleware_jwt_params_handler) -``` - ## Using local storage This is the default configuration. To change the location where the uploads are stored locally, use the steps in this section based on your installation method: -**In Omnibus GitLab installations:** - NOTE: -For historical reasons, uploads are stored into a base directory, which by -default is `uploads/-/system`. It's strongly discouraged to change this -configuration option for an existing GitLab installation. +For historical reasons, instance level uploads (for example the [favicon](../user/admin_area/appearance.md#favicon)) are stored into a base directory, +which by default is `uploads/-/system`. It is strongly discouraged to change the base +directory on an existing GitLab installation. + +**In Omnibus GitLab installations:** _The uploads are stored by default in `/var/opt/gitlab/gitlab-rails/uploads`._ @@ -55,16 +26,17 @@ _The uploads are stored by default in `/var/opt/gitlab/gitlab-rails/uploads`._ `/etc/gitlab/gitlab.rb` and add the following line: ```ruby - gitlab_rails['uploads_storage_path'] = "/mnt/storage/" - gitlab_rails['uploads_base_dir'] = "uploads" + gitlab_rails['uploads_directory'] = "/mnt/storage/uploads" ``` + This setting only applies if you haven't changed the `gitlab_rails['uploads_storage_path']` directory. + 1. Save the file and [reconfigure GitLab](restart_gitlab.md#omnibus-gitlab-reconfigure) for the changes to take effect. **In installations from source:** _The uploads are stored by default in -`/home/git/gitlab/public/uploads/-/system`._ +`/home/git/gitlab/public/uploads`._ 1. To change the storage path for example to `/mnt/storage/uploads`, edit `/home/git/gitlab/config/gitlab.yml` and add or amend the following lines: @@ -93,7 +65,7 @@ This configuration relies on valid AWS credentials to be configured already. We recommend using the [consolidated object storage settings](object_storage.md#consolidated-object-storage-configuration). The following instructions apply to the original configuration format. -## Object Storage Settings +### Object Storage Settings For source installations the following settings are nested under `uploads:` and then `object_store:`. On Omnibus GitLab installs they are prefixed by `uploads_object_store_`. @@ -106,14 +78,14 @@ For source installations the following settings are nested under `uploads:` and | `proxy_download` | Set to `true` to enable proxying all files served. Option allows to reduce egress traffic as this allows clients to download directly from remote storage instead of proxying all data | `false` | | `connection` | Various connection options described below | | -### Connection settings +#### Connection settings See [the available connection settings for different providers](object_storage.md#connection-settings). **In Omnibus installations:** _The uploads are stored by default in -`/var/opt/gitlab/gitlab-rails/public/uploads/-/system`._ +`/var/opt/gitlab/gitlab-rails/uploads`._ 1. Edit `/etc/gitlab/gitlab.rb` and add the following lines by replacing with the values you want: @@ -145,7 +117,7 @@ _The uploads are stored by default in **In installations from source:** _The uploads are stored by default in -`/home/git/gitlab/public/uploads/-/system`._ +`/home/git/gitlab/public/uploads`._ 1. Edit `/home/git/gitlab/config/gitlab.yml` and add or amend the following lines: @@ -165,12 +137,12 @@ _The uploads are stored by default in 1. Save the file and [restart GitLab](restart_gitlab.md#installations-from-source) for the changes to take effect. 1. Migrate any existing local uploads to the object storage using [`gitlab:uploads:migrate:all` Rake task](raketasks/uploads/migrate.md). -### OpenStack example +#### OpenStack example **In Omnibus installations:** _The uploads are stored by default in -`/var/opt/gitlab/gitlab-rails/public/uploads/-/system`._ +`/var/opt/gitlab/gitlab-rails/uploads`._ 1. Edit `/etc/gitlab/gitlab.rb` and add the following lines by replacing with the values you want: @@ -196,7 +168,7 @@ _The uploads are stored by default in **In installations from source:** _The uploads are stored by default in -`/home/git/gitlab/public/uploads/-/system`._ +`/home/git/gitlab/public/uploads`._ 1. Edit `/home/git/gitlab/config/gitlab.yml` and add or amend the following lines: |