summaryrefslogtreecommitdiff
path: root/doc/raketasks/spdx.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/raketasks/spdx.md')
-rw-r--r--doc/raketasks/spdx.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/raketasks/spdx.md b/doc/raketasks/spdx.md
new file mode 100644
index 00000000000..23eb27eb059
--- /dev/null
+++ b/doc/raketasks/spdx.md
@@ -0,0 +1,18 @@
+# SPDX license list import **(PREMIUM ONLY)**
+
+GitLab provides a Rake task for uploading a fresh copy of the [SPDX license list](https://spdx.org/licenses/)
+to a GitLab instance. This list is needed for matching the names of [License Compliance policies](../user/compliance/license_compliance/index.md).
+
+To import a fresh copy of the PDX license list, run:
+
+```shell
+# omnibus-gitlab
+sudo gitlab-rake gitlab:spdx:import
+
+# source installations
+bundle exec rake gitlab:spdx:import RAILS_ENV=production
+```
+
+To perform this task in the [offline environment](../user/application_security/offline_deployments/#defining-offline-environments),
+an outbound connection to [`licenses.json`](https://spdx.org/licenses/licenses.json) should be
+allowed.