Browse Source

DOC: user-set vars now in group_vars/sovereign

Allen Riddell 8 years ago
parent
commit
e0347b657d
1 changed files with 5 additions and 4 deletions
  1. 5
    4
      README.md

+ 5
- 4
README.md View File

@@ -95,7 +95,8 @@ Your new account will be automatically set up for passwordless `sudo`.
95 95
 
96 96
 ### 3. Configure your installation
97 97
 
98
-Modify the settings in `vars/user.yml` to your liking. If you want to see how they’re used in context, just search for the corresponding string.
98
+Modify the settings in `group_vars/sovereign` to your liking. If you want to see how they’re used in context, just search for the corresponding string.
99
+All of the variables in `group_vars/sovereign` must be set for sovereign to function.
99 100
 
100 101
 Setting `password_hash` for your mail users is a bit tricky. You can generate one using [doveadm-pw](http://wiki2.dovecot.org/Tools/Doveadm/Pw).
101 102
 
@@ -143,7 +144,7 @@ For Git hosting, copy your public key into place:
143 144
 
144 145
 	cp ~/.ssh/id_rsa.pub roles/git/files/gitolite.pub
145 146
 
146
-Finally, replace the TODOs in the file `hosts`. If your SSH daemon listens on a non-standard port, add a colon and the port number after the IP address. In that case you also need to add your custom port to the task `Set firewall rules for web traffic and SSH` in the file `roles/common/tasks/ufw.yml`.
147
+Finally, replace the `host.example.net` in the file `hosts`. If your SSH daemon listens on a non-standard port, add a colon and the port number after the IP address. In that case you also need to add your custom port to the task `Set firewall rules for web traffic and SSH` in the file `roles/common/tasks/ufw.yml`.
147 148
 
148 149
 ### 4. Set up DNS
149 150
 
@@ -174,7 +175,7 @@ To run just one or more piece, use tags. I try to tag all my includes for easy i
174 175
 
175 176
 You might find that it fails at one point or another. This is probably because something needs to be done manually, usually because there’s no good way of automating it. Fortunately, all the tasks are clearly named so you should be able to find out where it stopped. I’ve tried to add comments where manual intervention is necessary.
176 177
 
177
-The `dependencies` tag just installs dependencies, performing no other operations. The tasks associated with the `dependencies` tag do not rely on the user-provided settings that live in `vars/user.yml`. Running the playbook with the `dependencies` tag is particularly convenient for working with Docker images.
178
+The `dependencies` tag just installs dependencies, performing no other operations. The tasks associated with the `dependencies` tag do not rely on the user-provided settings that live in `group_vars/sovereign`. Running the playbook with the `dependencies` tag is particularly convenient for working with Docker images.
178 179
 
179 180
 ### 6. Finish DNS set-up
180 181
 
@@ -202,7 +203,7 @@ Similarly, to access the server monitoring page, use another SSH tunnel:
202 203
 
203 204
 Again proceeding to http://localhost:2812 in your web browser.
204 205
 
205
-Finally, sign into ownCloud with a new administrator account to set it up. You should select PostgreSQL as the configuration backend. Use `owncloud` as the database user and the database name. For the database password use the password you set for `owncloud_db_password` in `vars/user.yml`.
206
+Finally, sign into ownCloud with a new administrator account to set it up. You should select PostgreSQL as the configuration backend. Use `owncloud` as the database user and the database name. For the database password use the password you set for `owncloud_db_password` in `group_vars/sovereign`.
206 207
 
207 208
 How To Use Your New Personal Cloud
208 209
 ----------------------------------

Loading…
Cancel
Save