docs: Mi/2961/docker compose #3027

hajjimo · 2024-10-10T10:39:20Z

Checklist

Related issues linked using fixes #2961
Tests added/updated
Make sure that all checks pass
Bruno collection updated (if necessary)
Documentation issue created with user-docs label (if necessary)
OpenAPI specs updated (if necessary)

netlify · 2024-10-10T10:39:41Z

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

Name	Link
🔨 Latest commit	`682066b`
🔍 Latest deploy log	https://app.netlify.com/sites/brilliant-pasca-3e80ec/deploys/6710fd4c676f400008d712ab
😎 Deploy Preview	https://deploy-preview-3027--brilliant-pasca-3e80ec.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mkurapov · 2024-10-14T13:44:58Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx

+
+### Domain and subdomains setup
+
+We will map the [Open Payments resource server](/integration/services/backend-service#open-payments) to your domain, and the [ILP Connector](/integration/services/backend-service#interledger-connector), [Open Payments auth server](/integration/services/auth-service), and [Admin UI](/integration/services/frontend-service) to subdomains. Using the DNS host of your choice, set up your domain and subdomains according to the following convention:


(recommended) convention

mkurapov · 2024-10-14T13:46:16Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx


 ```sh

-    server_name admin.myrafiki.com;
+    server {


Suggested change

server {

server {

mkurapov · 2024-10-14T13:47:49Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx

+| 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 |


Should we outline briefly what each of these exposed ports do, or do you think this is enough?

mkurapov · 2024-10-14T13:55:33Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx

+
+### Open Payments Resource Server (`backend` package)
+
+Using the editor of your choice, save the following file as `oprs.config` in the `/etc/nginx/sites-available` directory on your VM:


oprs.config maybe can be more descriptive? also maybe can match the auth file name as well

mkurapov · 2024-10-15T11:12:42Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx

+
+### VM specifications
+
+This example deployment uses the `e2-standard-2` VM on <LinkOut href='https://cloud.google.com/compute/docs/general-purpose-machines#e2_machine_types'>Google Cloud Platform</LinkOut> with the following specifications:


Looking at this, maybe instead of specifying a specific cloud provider we can say something generic like, "a general-purpose VM with 4GB memory (I think 4GB should be enough actually) and 2 vCPUs should be capable of running the Rafiki software via docker."

mkurapov · 2024-10-15T11:13:38Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx

+:::danger[Update compose file]
+You must change the values enclosed within curly brackets {} in the following compose file.
+:::


Do you think it's obvious it needs changing? or good to have this warning?

mkurapov · 2024-10-15T11:14:17Z

packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx

 - Your Rafiki instance must be set up for at least one asset before wallet addresses can be created as each wallet address must have an asset assigned to it.
 - Wallet address URLs are treated as case-insensitive, meaning that both lowercase and uppercase variations of the same address will be recognized as identical.
-:::
+  :::


Suggested change

:::

:::

mkurapov · 2024-10-31T14:59:39Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx

+sudo ln -s /etc/nginx/sites-available/admin.conf /etc/nginx/sites-enabled/admin.conf
+
+sudo ln -s /etc/nginx/sites-available/open_payments_auth_server.conf /etc/nginx/sites-enabled/auth.conf
+
+sudo ln -s /etc/nginx/sites-available/ilp.conf /etc/nginx/sites-enabled/ilp.conf
+
+sudo ln -s /etc/nginx/sites-available/open_payments_resource_server.conf /etc/nginx/sites-enabled/oprs.conf


These should match the file names from above

mkurapov · 2024-10-31T15:01:20Z

packages/documentation/src/content/docs/integration/requirements/webhook-events.mdx

@@ -160,6 +160,22 @@ The first retry is after 10 seconds. Additional retries occur after 20 more seco

 #### Incoming payment created

+<details>


Should this change be here?

mkurapov · 2024-10-31T15:02:54Z

packages/documentation/src/content/docs/integration/prod/docker-compose.mdx

-| auth      | auth.DOMAIN      | auth.myrafiki.com      |
-| connector | connector.DOMAIN | connector.myrafiki.com |
-| ilp       | ilp.DOMAIN       | ilp.myrafiki.com       |
+### Install Docker Engine and Docker Compose plugin


Maybe we can just link to the docker engine install page? since it'll differ per distro
https://docs.docker.com/engine/install/

hajjimo added 2 commits October 9, 2024 17:27

Interim commit

cfd8f52

Added and rearranged sections

f36c22f

hajjimo requested a review from mkurapov October 10, 2024 10:39

github-actions bot added the pkg: documentation Changes in the documentation package. label Oct 10, 2024

Link to environment variables page

4884a08

hajjimo linked an issue Oct 11, 2024 that may be closed by this pull request

Add docker compose files to Docker Compose section in docs #2961

Open

mkurapov reviewed Oct 15, 2024

View reviewed changes

docs: updates per PR feedback

682066b

hajjimo requested a review from mkurapov October 17, 2024 12:16

mkurapov reviewed Oct 31, 2024

View reviewed changes

mkurapov mentioned this pull request Oct 31, 2024

docs: update docker compose integration docs #2973

Closed

6 tasks

mkurapov reviewed Oct 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Mi/2961/docker compose #3027

docs: Mi/2961/docker compose #3027

hajjimo commented Oct 10, 2024

netlify bot commented Oct 10, 2024 •

edited

Loading

mkurapov Oct 14, 2024

mkurapov Oct 14, 2024

mkurapov Oct 14, 2024

mkurapov Oct 14, 2024

mkurapov Oct 15, 2024

mkurapov Oct 15, 2024

mkurapov Oct 15, 2024

mkurapov Oct 31, 2024

mkurapov Oct 31, 2024

mkurapov Oct 31, 2024


		### Domain and subdomains setup

		We will map the [Open Payments resource server](/integration/services/backend-service#open-payments) to your domain, and the [ILP Connector](/integration/services/backend-service#interledger-connector), [Open Payments auth server](/integration/services/auth-service), and [Admin UI](/integration/services/frontend-service) to subdomains. Using the DNS host of your choice, set up your domain and subdomains according to the following convention:


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

		Using the editor of your choice, save the following file as `oprs.config` in the `/etc/nginx/sites-available` directory on your VM:


		### VM specifications

		This example deployment uses the `e2-standard-2` VM on <LinkOut href='https://cloud.google.com/compute/docs/general-purpose-machines#e2_machine_types'>Google Cloud Platform</LinkOut> with the following specifications:

		@@ -160,6 +160,22 @@ The first retry is after 10 seconds. Additional retries occur after 20 more seco

		#### Incoming payment created

		<details>

docs: Mi/2961/docker compose #3027

Are you sure you want to change the base?

docs: Mi/2961/docker compose #3027

Conversation

hajjimo commented Oct 10, 2024

Checklist

netlify bot commented Oct 10, 2024 • edited Loading

✅ Deploy Preview for brilliant-pasca-3e80ec ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Oct 10, 2024 •

edited

Loading