Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-pages.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Gaskill <ngaskill@gitlab.com>2021-02-03 20:17:28 +0300
committerNick Gaskill <ngaskill@gitlab.com>2021-02-03 20:17:28 +0300
commit0f0febeacdca934173e38a12a499cdfaa6e52c4e (patch)
tree5f92625e18186e0a343f94d0de6acf11e9731114
parentd68538cb568a0ac02844e08caf5094250409a27c (diff)
Apply 2 suggestion(s) to 1 file(s)
-rw-r--r--doc/development.md62
1 files changed, 35 insertions, 27 deletions
diff --git a/doc/development.md b/doc/development.md
index c4e46a6c..c94c4138 100644
--- a/doc/development.md
+++ b/doc/development.md
@@ -49,36 +49,44 @@ Pages access control is disabled by default. To enable it:
1. Modify your `config/gitlab.yml` file:
-```rb
-pages:
- access_control: true
+ ```rb
+ pages:
+ access_control: true
+ ```
```
-2. Restart GitLab (if running via GDK run: `gdk restart`)
-
-**NOTE**:
-Running `gdk reconfigure` will overwrite the value of `access_control` in `config/gitlab.yml`.
-
-3. In your local GitLab instance, navigate to `/admin/applications`
-4. Create an [OAuth application](https://docs.gitlab.com/ee/integration/oauth_provider.html#add-an-application-through-the-profile)
-5. Set the value of your redirect-uri to the `pages-domain` authorization endpoint, for example `http://192.168.1.135.nip.io:8090/auth`
-6. Add the following lines to your `gitlab-pages.conf` file
-
-```conf
-## the following are only needed if you want to test auth for private projects
-auth-client-id=$CLIENT_ID # generate a new OAuth application in http://127.0.0.1:3000/admin/applications
-auth-client-secret=$CLIENT_SECRET # obtained when generating an OAuth application
-auth-secret= $SOME_RANDOM_STRING # should be at least 32 bytes long
-auth-redirect-uri=http://192.168.1.135.nip.io:8090/auth
-```
-
-7. If running Pages inside the GDK, you can add the `gitlab-pages.conf` file to the `protected_config_files` section under `gdk` in your `gdk.yml` file
+1. Modify your `config/gitlab.yml` file:
-```yaml
-gdk:
- protected_config_files:
- - 'gitlab-pages/gitlab-pages.conf'
-```
+ ```rb
+ pages:
+ access_control: true
+ ```
+
+1. Restart GitLab (if running through the GDK, run `gdk restart`). Note that running
+ `gdk reconfigure` overwrites the value of `access_control` in `config/gitlab.yml`.
+
+1. In your local GitLab instance, navigate to `/admin/applications`.
+1. Create an [OAuth application](https://docs.gitlab.com/ee/integration/oauth_provider.html#add-an-application-through-the-profile).
+1. Set the value of your `redirect-uri` to the `pages-domain` authorization endpoint (for example
+ `http://192.168.1.135.nip.io:8090/auth`).
+1. Add these lines to your `gitlab-pages.conf` file:
+
+ ```conf
+ ## the following are only needed if you want to test auth for private projects
+ auth-client-id=$CLIENT_ID # generate a new OAuth application in http://127.0.0.1:3000/admin/applications
+ auth-client-secret=$CLIENT_SECRET # obtained when generating an OAuth application
+ auth-secret= $SOME_RANDOM_STRING # should be at least 32 bytes long
+ auth-redirect-uri=http://192.168.1.135.nip.io:8090/auth
+ ```
+
+1. If running Pages inside the GDK, you can add the `gitlab-pages.conf` file to the
+ `protected_config_files` section under `gdk` in your `gdk.yml` file:
+
+ ```yaml
+ gdk:
+ protected_config_files:
+ - 'gitlab-pages/gitlab-pages.conf'
+ ```
## Developing inside the GDK