viveksantayana/ska-referee-test
viveksantayana/ska-referee-test
1
0
Fork 0
Code Issues 1 Pull Requests Projects Releases 19 Wiki Activity

Updated readme formatting

Browse Source
This commit is contained in:
Vivek Santayana 2022-08-19 12:02:54 +01:00
parent 552b2ffc47
commit 0387c05055
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -29,12 +29,11 @@ To set up the server, consult some of the comprehensive guides on various hostin
Here is a [good starting point on setting up a server](https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-22-04). Here is a [good starting point on setting up a server](https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-22-04).
To install Docker and Docker Compose, consult the respective documentation: To install Docker and Docker Compose, consult the respective documentation:
- [Install on Ubuntu](https://docs.docker.com/engine/install/ubuntu/) or [Install on Debian](https://docs.docker.com/engine/install/debian/) - [Install on Ubuntu](https://docs.docker.com/engine/install/ubuntu/) or [Install on Debian](https://docs.docker.com/engine/install/debian/)
- Docker Compose should be installed as part of that. - Docker Compose should be installed as part of that.
``` > At the time of writing, there has been an upgrade to Docker and Docker Compose, meaning the syntax below might be different between versions.
At the time of writing, there has been an upgrade to Docker and Docker Compose, meaning the syntax below might be different between versions.
```
Check if Git is installed on your server using the `git --version` command. Check if Git is installed on your server using the `git --version` command.
If it isn't installed, install it. If it isn't installed, install it.
@ -72,13 +71,13 @@ Also make sure that the various entries for usernames and passwords match.
There are some values in the following four files you will need to configure to reflect the domain you are installing this app. There are some values in the following four files you will need to configure to reflect the domain you are installing this app.
``` ```sh
# .env # .env
SERVER_NAME= # URL where this will be hosted. SERVER_NAME= # URL where this will be hosted.
``` ```
``` ```sh
# install-script.sh # install-script.sh
domains=(example.org www.example.org) domains=(example.org www.example.org)
@ -87,7 +86,7 @@ email="" # Adding a valid address is strongly recommended
Substitute the domain name `domain_name` in the two file paths in the following file: Substitute the domain name `domain_name` in the two file paths in the following file:
``` ```sh
# nginx/ssl.conf # nginx/ssl.conf
ssl_certificate /etc/letsencrypt/live/domain_name/fullchain.pem; ssl_certificate /etc/letsencrypt/live/domain_name/fullchain.pem;
@ -95,9 +94,9 @@ ssl_certificate_key /etc/letsencrypt/live/domain_name/privkey.pem;
... ...
``` ```
And **six** locations in the following file, two for the regular version of the domain and two for the www version: And **six** locations in the following file, two for the regular version of the domain and four for the www version (remember to keep the www. prefix where present):
``` ```nginx
# nginx/conf.d/ref-test-app.conf # nginx/conf.d/ref-test-app.conf
server { server {
@ -140,9 +139,9 @@ This will be set up automatically.
However, there is a specific chicken-and-egg problem as the web server, Nginx, won't run without certificates, Certbot, the certificate generator, won't run without the web server. However, there is a specific chicken-and-egg problem as the web server, Nginx, won't run without certificates, Certbot, the certificate generator, won't run without the web server.
So to solve this, there is an automation script we can run that will set up a dummy certificate and then issue the appropriate certificates for us. So to solve this, there is an automation script we can run that will set up a dummy certificate and then issue the appropriate certificates for us.
``` ```sh
$ chmod +x install-script.sh chmod +x install-script.sh
$ sudo ./install-script.sh sudo ./install-script.sh
``` ```
This will take a long time to run the first time because it will try and generate a fairly sizeable cypher. This will take a long time to run the first time because it will try and generate a fairly sizeable cypher.