Skip to content

Commit df5fdc9

Browse files
committed
clean up digital ocean to match AWS
1 parent 9bbe7ea commit df5fdc9

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

docs/cloud/digital-ocean.md

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,40 @@
11
# DigitalOcean
22

3-
DigitalOcean, Inc. ([digitalocean.com](http://digitalocean.com)) is a
4-
cloud infrastructure provider that provides cloud services to developers
5-
to help to deploy and scale applications that run simultaneously on
6-
multiple computers.
7-
8-
The following is a step-by-step guide to installing DocNow using
9-
macOS.
10-
11-
It is intended for anyone without prior experience.
3+
The following is a step-by-step guide to installing DocNow in DigitalOceean. The instructions use terminology for macOS. You should be able to follow these instructions without prior experience with DigitalOcean or macOS Terminal, but if this is your first time administering an application, fair warning! This may take up to 2 hours to install.
124

135
Please follow each step carefully and open an issue on the [Github
146
Repository](https://github.com/DocNow/docnow-ansible/issues) if you find
157
something missing.
168

17-
### 1. Create an SSH Key
9+
### 1. Install Ansible
10+
11+
Ansible will be used to configure the Virtual Private Server you will be setting up on [AWS Lightsail](https://aws.amazon.com/lightsail/?p=gsrc&c=ho_lvm). This server will host the DocNow App.
12+
13+
You will need a Programmers Editors like [Microsoft's VSCode](https://code.visualstudio.com) to make edits below
14+
15+
Start by opening the Terminal application on your Mac in `Applications/Utilities`
16+
17+
Install Homebrew by copying the following into your Terminal:
18+
19+
``` /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" ```
20+
21+
*This will take a few minutes*
22+
23+
Then copy the following into your Terminal:
24+
25+
```git -C /usr/local/Homebrew/Library/Taps/homebrew/homebrew-core fetch --unshallow```
26+
27+
*This will take a few minutes*
28+
29+
Then install Ansible by copying the following into your Terminal:
30+
31+
``` brew install ansible ```
32+
33+
Now your computer has the tools it needs to interface with DigitalOcean
34+
35+
### 2. Sign up for Digital Ocean
36+
37+
### Create an SSH Key
1838

1939
To host your Docnow Application on DigitalOcean you will need SSH
2040
(Secure Shell, allows for secure access to remote servers).
@@ -38,7 +58,7 @@ ssh-keygen -f ~/.ssh/docnow_id_rsa
3858
```
3959

4060
This will save your DigitalOcean keys under a hidden directory name
41-
`/Users/<macOSusername>/.ssh` which is the default location of your ssh keys.
61+
`/Users/[macOSusername]/.ssh` which is the default location of your ssh keys.
4262
You can list the contents of the directory by running the following:
4363

4464
```bash
@@ -58,7 +78,7 @@ Enter without typing anything to save it to the default location.
5878
```bash
5979
Generating public/private rsa key pair.
6080
Enter file in which to save the key
61-
(/Users/username/.ssh/docnow_id_rsa):
81+
(/Users/[macOSusername]/.ssh/docnow_id_rsa):
6282
```
6383

6484
After hitting enter, you'll be prompted for an optional passphrase which
@@ -75,21 +95,21 @@ Enter same passphrase again:
7595
```
7696

7797
⚠️Note: Nothing will appear in the terminal as you enter your
78-
passphrase. This is intentional. You\'re still typing though.
98+
passphrase. This is intentional. You're still typing though.
7999

80100
You now have a public and private key that you'll use to authenticate
81101
with the server droplet you'll create. The screen output will look like
82102
this:
83103

84104
```bash
85105
Your identification has been saved in
86-
/Users/username/.ssh/docnow_id_rsa.
106+
/Users/[macOSusername]/.ssh/docnow_id_rsa.
87107
Your public key has been saved in
88-
/Users/username/.ssh/docnow_id_rsa.pub.
108+
/Users/[macOSusername]/.ssh/docnow_id_rsa.pub.
89109

90110
The key fingerprint is:
91111

92-
a9:49:EX:AM:PL:E3:3e:a9:de:4e:77:11:58:b6:90:26 username@mac-mini
112+
a9:49:EX:AM:PL:E3:3e:a9:de:4e:77:11:58:b6:90:26 [macOSusername]@mac-mini
93113

94114
The key's randomart image is:
95115
+--[ RSA 2048]----+
@@ -114,18 +134,16 @@ terminal to display your public key:
114134
cat ~/.ssh/docnow_id_rsa.pub*
115135
```
116136
117-
Copy all the output to a text file, as we\'ll use it when creating a
137+
Copy all the output to a text file, as we'll use it when creating a
118138
DigitalOcean droplet in the next steps.
119139

120-
### 2. Sign up for Digital Ocean
121-
122140
Your machine will connect to a server and admin that you alone have
123141
access to, and from which you control the machine's settings.
124142
125143
DocNow is written to run on most cloud providers including DigitalOcean
126144
and you will need a virtual private server host (VPS).
127145
128-
(Advanced users may install the docnow application using DigitalOcean\'s
146+
(Advanced users may install the docnow application using DigitalOcean's
129147
API.)
130148

131149
**Create an account**
@@ -154,15 +172,15 @@ distribution (instead of the default 20.04):
154172

155173
Select the **4 GB / 2 CPUs** option for your droplet size:
156174

157-
**Do not click the green create button yet**, as we\'ll continue to
175+
**Do not click the green create button yet**, as we'll continue to
158176
additional options in the next steps.
159177
160178
# Droplet creation (options & SSH key)
161179
162180
After choosing the droplet size, and location closest to you, consider
163181
checking the box for **Monitoring** in the additional options section:
164182
165-
The monitoring option will allow you to later track your droplet\'s
183+
The monitoring option will allow you to later track your droplet's
166184
resource usage from your DigitalOcean account.
167185

168186
Then, under the **Authentication** section, choose **`SSH keys`** and
@@ -216,28 +234,10 @@ software
216234
217235
### 3. Installing the Docnow software
218236
219-
- Install Homebrew
220-
```bash
221-
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
222-
```
223-
- Most versions of macOS already have git installed. If you happen to
224-
find yours not to have it installed.
225-
226-
```bash
227-
brew install git
228-
```
229-
230-
- Install Ansible
231-
232-
```bash
233-
brew install ansible
234-
```
235-
236-
- Edit the `hosts.example` file in the cloned
237-
docnow-ansible repository. Replace the [1.2.3.4` in the
238-
file with your DigitalOcean Droplet IP address above. Make a copy of
239-
the file and name it `hosts`
240-
- You can now run:
237+
* Download and unzip the [docnow-ansible](https://github.com/docnow/docnow-ansible) zip file or, if you are a GitHub user, clone the repository to a location on your computer.
238+
* Move the docnow-ansible folder to your Documents folder
239+
* Modify the `hosts.example` to have the IP address from the steps above.
240+
* rename the file `hosts.example` file to `hosts`
241241
242242
```bash
243243
ansible-playbook -i hosts playbooks/do_install.yml

0 commit comments

Comments
 (0)