Commit c3d3b262 authored by les's avatar les
Browse files

Merge branch 'docs-updates' into 'master'

Updates to Docker & Nginx install steps

Informs user to install Docker, Docker Compose and Nginx. Informs user which directory Nginx files should be placed in. Changes Nginx information to match that which is on the gancio.org webpage.

See merge request !9
parents 81a0fb42 5bef73fb
......@@ -19,8 +19,15 @@ mkdir -p /opt/gancio
cd /opt/gancio
```
- __You must have the following installed: Docker, Docker Compose and Nginx __
1. https://docs.docker.com/engine/install/
1. https://docs.docker.com/compose/install/
1. https://nginx.org/en/docs/install.html
## Use sqlite
<div class='code-example bg-grey-lt-100' markdown="1">
1. **Download docker-compose.yml and Dockerfile**
```bash
wget {{site.url}}{% link /docker/Dockerfile %}
......@@ -66,6 +73,12 @@ docker-compose up -d
tail -f data/logs/gancio.log
```
1. Navigate away from Gancio directory & into Nginx Directory
```bash
cd ~
cd /etc/nginx/sites-available
```
1. [Setup nginx as a proxy]({% link install/nginx.md %}
1. Point your web browser to [http://localhost:13120](http://localhost:13120) or where you specified during setup and enjoy :tada:
......@@ -96,4 +109,4 @@ tail -f data/logs/gancio.log
```bash
cd /opt/gancio
docker-compose up -d --no-deps --build
```
\ No newline at end of file
```
......@@ -8,69 +8,35 @@ parent: Install
## Nginx proxy configuration
This is the default nginx configuration for gancio, please modify at least the **server_name** and **ssl_certificate**'s path.
Note that this does not include a cache configuration and that gancio does
not use a cache control at all, if you can help with this task you're
welcome.
This is the default nginx configuration for gancio, please modify at least «YOUR_DOMAIN». Note that it does not include HTTPS setup but you can easily use [certbot](https://certbot.eff.org/) for that.
- __You should be in the correct directory__
`/etc/nginx/sites-available`
```nginx
server {
listen 80;
listen [::]:80;
server_name gancio.cisti.org;
root /var/www/letsencrypt;
location /.well-known/acme-challenge/ { allow all; }
location / { return 301 https://$host$request_uri; }
}
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
server_name gancio.cisti.org;
ssl_protocols TLSv1.2;
ssl_ciphers HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA;
ssl_prefer_server_ciphers on;
ssl_session_cache shared:SSL:10m;
# Uncomment these lines once you acquire a certificate:
# ssl_certificate /etc/letsencrypt/live/gancio.cisti.org/fullchain.pem;
# ssl_certificate_key /etc/letsencrypt/live/gancio.cisti.org/privkey.pem;
server_name <<YOUR_DOMAIN>>;
keepalive_timeout 70;
sendfile on;
client_max_body_size 80m;
gzip on;
gzip_disable "msie6";
gzip_vary on;
gzip_proxied any;
gzip_comp_level 6;
gzip_buffers 16 8k;
gzip_http_version 1.1;
gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;
add_header Strict-Transport-Security "max-age=31536000";
location / {
try_files $uri @proxy;
}
location @proxy {
proxy_set_header Host $host;
proxy_set_header X-Forwarded-Proto https;
proxy_set_header Proxy "";
proxy_pass_header Server;
proxy_pass http://127.0.0.1:13120;
proxy_buffering on;
proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
tcp_nodelay on;
}
}
```
- __Following this, you should create a link to the file in sites-enabled:__
```bash
ln -s /etc/nginx/sites-available/<your-config> /etc/nginx/sites-enabled/
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment