Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update docker compose integration docs #2973

Closed
wants to merge 1 commit into from
Closed

docs: update docker compose integration docs #2973

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 40 additions & 39 deletions packages/documentation/src/content/docs/integration/prod/docker-compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,34 +29,34 @@ As Let's encrypt certificates are valid for 90 days, you must set up a cron proc
```sh
crontab -e
​
0 3 * * * crontab renew
0 3 * * * certbot renew
```

## Update DNS records

Next update the DNS records to point to the static external IP address of the volumes:
Next update the DNS records (A records) to point to the static external IP address of the virtual machine:

| service | URL | example |
| --------- | ---------------- | ---------------------- |
| admin | admin.DOMAIN | admin.myrafiki.com |
| auth | auth.DOMAIN | auth.myrafiki.com |
| connector | connector.DOMAIN | connector.myrafiki.com |
| ilp | ilp.DOMAIN | ilp.myrafiki.com |
| service | URL | example |
| ----------------------------- | ------------ | ------------------ |
| Open Payments resource server | DOMAIN | myrafiki.com |
| ILP Connector | ilp.DOMAIN | ilp.myrafiki.com |
| Open Payments auth server | auth.DOMAIN | auth.myrafiki.com |
| Admin UI | admin.DOMAIN | admin.myrafiki.com |

## Server preparation

Create nginx configuration files for every exposed domain:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will need to explain that these files should be in the /etc/nginx/sites-available config folder, and then symlinked to the /etc/nginx/sites-enabled folder. Maybe would be nice to give the file names to these nginx config files?


### Admin
### Open Payments Resource Server (`backend` package)

```sh

server_name admin.myrafiki.com;
server {
server_name myrafiki.com;

listen 443 ssl;

ssl_certificate /etc/letsencrypt/live/admin.myrafiki.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/admin.myrafiki.com/privkey.pem;
ssl_certificate /etc/letsencrypt/live/myrafiki.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/myrafiki.com/privkey.pem;

include /etc/letsencrypt/options-ssl-nginx.conf;
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
Expand All @@ -72,33 +72,33 @@ Create nginx configuration files for every exposed domain:

proxy_pass_request_headers on;

proxy_pass http://localhost:4010;
proxy_pass http://localhost:3000;
}
}

server {
server_name admin.myrafiki.com;
server_name myrafiki.com;

listen 80;

if ($host = admin.myrafiki.com) {
if ($host = myrafiki.com) {
return 301 https://$host$request_uri;
}

return 404;
}
```

### Auth
### ILP Connector (`backend` package)

```sh
server {
server_name auth.myrafiki.com;
server_name ilp.myrafiki.com;

listen 443 ssl;

ssl_certificate /etc/letsencrypt/live/auth.myrafiki.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/auth.myrafiki.com/privkey.pem;
ssl_certificate /etc/letsencrypt/live/ilp.myrafiki.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/ilp.myrafiki.com/privkey.pem;

include /etc/letsencrypt/options-ssl-nginx.conf;
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
Expand All @@ -119,27 +119,28 @@ server {
}

server {
server_name auth.myrafiki.com;
server_name ilp.myrafiki.com;

listen 80;

if ($host = auth.myrafiki.com) {
return 301 https://$host$request_uri;
if ($host = ilp.myrafiki.com) {
return 301 https://$host$request_uri;
}

return 404;
}
```

### Connector
### Open Payments Auth Server (`auth` package)

```sh
server {
server_name connector.myrafiki.com;
server_name auth.myrafiki.com;

listen 443 ssl;
ssl_certificate /etc/letsencrypt/live/connector.myrafiki.com/fullchain.pem; # managed by Certbot
ssl_certificate_key /etc/letsencrypt/live/connector.myrafiki.com/privkey.pem; # managed by Certbot

ssl_certificate /etc/letsencrypt/live/auth.myrafiki.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/auth.myrafiki.com/privkey.pem;

include /etc/letsencrypt/options-ssl-nginx.conf;
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
Expand All @@ -155,33 +156,33 @@ server {

proxy_pass_request_headers on;

proxy_pass http://localhost:3002;
proxy_pass http://localhost:3006;
}
}

server {
server_name connector.myrafiki.com;
server_name auth.myrafiki.com;

listen 80;

if ($host = connector.myrafiki.com) {
return 301 https://$host$request_uri;
if ($host = auth.myrafiki.com) {
return 301 https://$host$request_uri;
}

return 404;
}
```

### ILP
### Admin (`frontend` package)

```sh
server {
server_name ilp.myrafiki.com;
server_name admin.myrafiki.com;

listen 443 ssl;

ssl_certificate /etc/letsencrypt/live/ilp.myrafiki.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/ilp.myrafiki.com/privkey.pem;
ssl_certificate /etc/letsencrypt/live/admin.myrafiki.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/admin.myrafiki.com/privkey.pem;

include /etc/letsencrypt/options-ssl-nginx.conf;
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;
Expand All @@ -197,17 +198,17 @@ server {

proxy_pass_request_headers on;

proxy_pass http://localhost:4000;
proxy_pass http://localhost:3005;
}
}

server {
server_name ilp.myrafiki.com;
server_name admin.myrafiki.com;

listen 80;

if ($host = ilp.myrafiki.com) {
return 301 https://$host$request_uri;
if ($host = admin.myrafiki.com) {
return 301 https://$host$request_uri;
}

return 404;
Expand Down
Loading