Browse Source

Merge pull request #634 from OKNoah/patch-1

Clarifies environments, adds non-passwordless option
Luke Cyca 8 years ago
parent
commit
3f97b7ee54
1 changed files with 17 additions and 3 deletions
  1. 17
    3
      README.md

+ 17
- 3
README.md View File

@@ -63,6 +63,10 @@ You do not need to acquire an SSL certificate.  The SSL certificates you need wi
63 63
 Installation
64 64
 ------------
65 65
 
66
+## On the remote server
67
+
68
+The following steps are done on the remote server by `ssh`ing into it and running these commands.
69
+
66 70
 ### 1. Install required packages
67 71
 
68 72
     apt-get install sudo
@@ -96,11 +100,19 @@ Authorize your ssh key if you want passwordless ssh login (optional):
96 100
     chown deploy:deploy /home/deploy -R
97 101
     echo 'deploy ALL=(ALL) NOPASSWD: ALL' > /etc/sudoers.d/deploy
98 102
 
99
-Your new account will be automatically set up for passwordless `sudo`.
103
+Your new account will be automatically set up for passwordless `sudo`. Or you can just add your `deploy` user to the sudo group.
104
+
105
+    adduser deploy sudo
106
+
107
+## On your local machine
108
+
109
+Ansible (the tool setting up your server) runs locally on your computer and sends commands to the remote server. Download this repository somewhere on your machine, either through `Clone or Download > Download ZIP` above, `wget`, or `git` as below
110
+    
111
+    git clone https://github.com/sovereign/sovereign.git
100 112
 
101 113
 ### 4. Configure your installation
102 114
 
103
-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.
115
+Modify the settings in the `group_vars/sovereign` folder to your liking. If you want to see how they’re used in context, just search for the corresponding string.
104 116
 All of the variables in `group_vars/sovereign` must be set for sovereign to function.
105 117
 
106 118
 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).
@@ -172,7 +184,9 @@ First, make sure you’ve [got Ansible 1.9.3+ installed](http://docs.ansible.com
172 184
 
173 185
 To run the whole dang thing:
174 186
 
175
-    ansible-playbook -i ./hosts site.yml
187
+    ansible-playbook -i --ask-sudo-pass ./hosts site.yml
188
+    
189
+If you chose to make a passwordless sudo deploy user, you can omit the `--ask-sudo-pass` argument.
176 190
 
177 191
 To run just one or more piece, use tags. I try to tag all my includes for easy isolated development. For example, to focus in on your firewall setup:
178 192
 

Loading…
Cancel
Save