From c536400d551ca7e3650d340f781f4826cf6c3d22 Mon Sep 17 00:00:00 2001 From: Job van der Voort Date: Tue, 14 Jul 2015 13:45:24 +0200 Subject: small update to docs --- doc/install/installation.md | 16 ++++++++-------- doc/update/7.12-to-7.13.md | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/install/installation.md b/doc/install/installation.md index cdd87ae..9f476b6 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -118,10 +118,10 @@ We recommend PostgreSQL but you can also use MySQL sudo -u gitlab_ci -H editor config/application.yml # Development #sudo -u gitlab_ci -H cp config/application.yml.example.development config/application.yml - - # Copy reference secrets + + # Copy the example secrets file sudo -u gitlab_ci -H cp config/secrets.yml.example config/secrets.yml - + # Edit web server settings sudo -u gitlab_ci -H cp config/unicorn.rb.example config/unicorn.rb sudo -u gitlab_ci -H editor config/unicorn.rb @@ -131,8 +131,8 @@ We recommend PostgreSQL but you can also use MySQL sudo chmod -R u+rwX tmp/sockets/ sudo -u gitlab_ci -H mkdir -p tmp/pids/ sudo chmod -R u+rwX tmp/pids/ - - # Change permission of directory where build traces are stored + + # Change the permissions of the directory where build traces are stored sudo chmod -R u+rwX builds/ # Make sure GitLab CI can write to the builds/ directory @@ -165,9 +165,9 @@ We recommend PostgreSQL but you can also use MySQL ### Secure secrets.yml -Secrets file stores encryption keys for sessions and secure variables. -Backup `secrets.yml` someplace safe, but don't store them in the same place as your database backups. -Otherwise your secrets are exposed in case one of your backups is compromised. +The `secrets.yml` file stores encryption keys for sessions and secure variables. +Backup `secrets.yml` someplace safe, but don't store it in the same place as your database backups. +Otherwise your secrets are exposed if one of your backups is compromised. ## 8. Install Init Script diff --git a/doc/update/7.12-to-7.13.md b/doc/update/7.12-to-7.13.md index 046f684..7fc85f6 100644 --- a/doc/update/7.12-to-7.13.md +++ b/doc/update/7.12-to-7.13.md @@ -30,10 +30,10 @@ sudo chmod -R u+rwX builds ### 4. Copy secrets -Secrets file is used to store keys to encrypt sessions and encrypt secure variables. -When you run migrations store it someplace safe, -but don't store them in the same place as your database backups. -Otherwise your secrets are exposed in case one of your backups is compromised. +The `secrets.yml` file is used to store keys to encrypt sessions and encrypt secure variables. +When you run migrations make sure to store it someplace safe. +Don't store it in the same place as your database backups, +otherwise your secrets are exposed if one of your backups is compromised. ``` sudo -u gitlab_ci -H cp config/secrets.yml.example config/secrets.yml -- cgit v1.2.1