summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-11-22 21:41:55 +0000
committerAchilleas Pipinellis <axilleas@axilleas.me>2016-11-22 21:41:55 +0000
commit52750aab2a77e8a8f2fb5159cf90286bf1603685 (patch)
treeedf3329d5d3855047750391fdccded4e57accb56
parentb6dc727de143459469a400c17dcccdd805f4afb8 (diff)
parentdeb39a017685c303cbaad2e9a07c8fb9b1636e67 (diff)
downloadgitlab-ce-52750aab2a77e8a8f2fb5159cf90286bf1603685.tar.gz
Merge branch 'doc-for-config' into 'master'
Add some clarification for some files under config/* Add some clarification for some files under config/* I didn't add a lot of them because I am not very familiar about how they work and I am not sure if we really need to explain files like config/database.yml because if you know Rails you must know how that works. At any rate, I think this is a beginning and we could keep documenting more files in the future. Closes #18373 See merge request !4851
-rw-r--r--config/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/config/README.md b/config/README.md
new file mode 100644
index 00000000000..0a5ea2424e0
--- /dev/null
+++ b/config/README.md
@@ -0,0 +1,22 @@
+# Configuration files Documentation
+
+Note that most configuration files (`config/*.*`) committed into
+[gitlab-ce](https://gitlab.com/gitlab-org/gitlab-ce) **will not be used** for
+[omnibus-gitlab](https://gitlab.com/gitlab-org/omnibus-gitlab). Configuration
+files committed into gitlab-ce are only used for development.
+
+## gitlab.yml
+
+You can find most of GitLab configuration settings here.
+
+## mail_room.yml
+
+This file is actually an YML wrapped inside an ERB file to enable templated
+values to be specified from `gitlab.yml`. mail_room loads this file first as
+an ERB file and then loads the resulting YML as its configuration.
+
+## resque.yml
+
+This file is called `resque.yml` for historical reasons. We are **NOT**
+using Resque at the moment. It is used to specify Redis configuration
+values instead.