Explorar el Código

Basic documentation (#1)

* Updates to docker-compose.yml to fix persistency and security

* Step 1, prerequisites

* Added Steps to follow
master
Jesus Federico hace 4 años
padre
commit
52e276e023
No account linked to committer's email address
Se han modificado 1 ficheros con 112 adiciones y 0 borrados
  1. 112
    0
      README.md

+ 112
- 0
README.md Ver fichero

@@ -6,8 +6,120 @@ using docker-compose.
6 6
 
7 7
 ## Prerequisites
8 8
 
9
+- Install
10
+[docker](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-18-04)
11
+  and
12
+[docker-compose](https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-18-04)
13
+
14
+- Make sure you have access to Blindside Networks private repository in
15
+  [dockerhub](https://cloud.docker.com/u/blindsidenetwks/repository/list) particularly to:
16
+
17
+  - [scalelite](https://cloud.docker.com/u/blindsidenetwks/repository/docker/blindsidenetwks/scalelite)
18
+
19
+- Make sure you have your own DNS and a public domain name or a delegated one under blindside-dev.com
20
+  (e.g. <JOHN>.blindside-dev.com)
21
+
9 22
 
10 23
 ## Preliminary steps
11 24
 
12 25
 
13 26
 ## Steps
27
+
28
+Clone this repository:
29
+
30
+```
31
+git clone git@github.com:blindsidenetworks/scalelite-run.git
32
+cd scalelite-run
33
+```
34
+
35
+Copy  `dotenv` file located in the root of the project as `.env` and edit it
36
+
37
+```
38
+vi .env
39
+```
40
+
41
+You will need to replace both variables as in:
42
+`DOMAIN_ROOT=bigbluebutton.org` to the one assigned to you (e.g. `DOMAIN_ROOT=blindside-dev.com`)
43
+`DOMAIN_SUB=lab` to the one assigned to you (e.g. `DOMAIN_SUB=<JOHN>`)
44
+
45
+Create your own SSL Letsencrypt certificates. As you are normally going to
46
+have this deployment running on your own computer (or in a private VM), you
47
+need to generate the SSL certificates with certbot by adding the challenge to
48
+your DNS.
49
+
50
+Install letsencrypt in your own computer
51
+
52
+```
53
+sudo apt-get update
54
+sudo apt-get -y install letsencrypt
55
+```
56
+
57
+Make yourself root
58
+
59
+```
60
+sudo -i
61
+```
62
+
63
+Start creating the certificates
64
+
65
+```
66
+certbot certonly --manual -d sl.<JOHN>.blindside-dev.com --agree-tos --no-bootstrap --manual-public-ip-logging-ok --preferred-challenges=dns --email hostmaster@blindsdie-dev.com --server https://acme-v02.api.letsencrypt.org/directory
67
+```
68
+
69
+You will see something like this
70
+```
71
+-server https://acme-v02.api.letsencrypt.org/directory
72
+Saving debug log to /var/log/letsencrypt/letsencrypt.log
73
+Plugins selected: Authenticator manual, Installer None
74
+Obtaining a new certificate
75
+Performing the following challenges:
76
+dns-01 challenge for gl.<JOHN>.blindside-dev.com
77
+dns-01 challenge for gl.<JOHN>.blindside-dev.com
78
+
79
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
80
+Please deploy a DNS TXT record under the name
81
+_acme-challenge.sl.<JOHN>.blindside-dev.com with the following value:
82
+
83
+2dxWYkcETHnimmQmCL0MCbhneRNxMEMo9yjk6P_17kE
84
+
85
+Before continuing, verify the record is deployed.
86
+- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
87
+Press Enter to Continue
88
+```
89
+
90
+Create a TXT record in your DNS for
91
+`_acme-challenge.sl.<JOHN>.blindside-dev.com` with the challenge string as
92
+its value `2dxWYkcETHnimmQmCL0MCbhneRNxMEMo9yjk6P_17kE`
93
+
94
+Copy the certificates to your scalelite-run directory. Although `/etc/letsencrypt/live/`
95
+holds the latest certificate, they are only symbolic links. The real files must be copied and renamed
96
+
97
+```
98
+cp -R /etc/letsencrypt/archive/sl.<JOHN>.blindside-dev.com <YOUR ROOT>/scalelite-run/nginx/letsencrypt/live
99
+```
100
+
101
+```
102
+cd <YOUR ROOT>/scalelite-run/nginx/letsencrypt/live/sl.<JOHN>.blindside-dev.com/
103
+mv cert1.pem cert.pem
104
+mv chain1.pem chain.pem
105
+mv fullchain1.pem fullchain.pem
106
+mv privkey1.pem privkey.pem
107
+```
108
+
109
+As you have to have access to dockerhub private repositories sign in into docker hub with your account
110
+with `docker login -u <YOUR_USERNAME> -p <YOUR_PASSWORD>` or `docker login -u <YOUR_USERNAME>` if you
111
+want to type your password using the stdin
112
+
113
+And finally, start your environment with docker-compose
114
+
115
+```
116
+cd <YOUR ROOT>/scalelite-run
117
+docker-compose up
118
+```
119
+
120
+If everything goes well, you will see all the containers starting and at the
121
+end you will have access to scalelite through:
122
+
123
+```
124
+https://sl.<JOHN>.blindside-dev.com/bigbluebutton/api
125
+```

Loading…
Cancelar
Guardar