Skip to content

Commit ffe1500

Browse files
replace yaml-merge with yq, fix quickstart deployment docs. Closes #1780 (#1782)
* replace yaml-merge with yq, fix quickstart deployment docs. Closes #1780 * WIP- rephrase production-docker-compose.yml creation sentence * Minor changes to quickstart docs, docker-compose, deploy-deepforge 1. Revert to docker-compose.yml with ${TOKEN_KEYS_DIR} mount 2. Remove NODE_ENV=default from docker-compose.yml and fix key removal 3. Change documentation quickstart with docker using docker-compose run * WIP- remove NODE_ENV=production quickstrat docs * WIP remove -e from docker quickstart tutorial
1 parent 36a8ed7 commit ffe1500

File tree

3 files changed

+5
-19
lines changed

3 files changed

+5
-19
lines changed

.deployment/deploy-deepforge

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ fi;
1717
rm config/components2.json
1818

1919
# Merging the custom override yml file
20-
yaml-merge docker/docker-compose.yml "$DEEPFORGE_DEPLOYMENT_DIR"/docker-compose-overrides.yml > custom-docker-compose.yml
20+
yq m -a docker/docker-compose.yml "$DEEPFORGE_DEPLOYMENT_DIR"/docker-compose-overrides.yml > custom-docker-compose.yml
2121

2222
# Pulling the latest docker image, stopping the server, removing and restarting it
2323
docker-compose --file custom-docker-compose.yml -p deepforge pull $SERVER_NAME

.deployment/docker-compose-overrides.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ services:
55
- "DEEPFORGE_HOST=https://dev.deepforge.org"
66
- "DEEPFORGE_INTERACTIVE_COMPUTE_HOST=https://dev-compute.deepforge.org"
77
volumes:
8-
- "$HOME/.deepforge/blob:/data/blob"
9-
- "${TOKEN_KEYS_DIR}:/token_keys"
108
- "${DEEPFORGE_DEPLOYMENT_DIR}:/.deployment"
119
- "${DEEPFORGE_DEPLOYMENT_DIR}/../config/components.json:/deepforge/config/components.json"
1210

docs/deployment/quick_start.rst

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,23 +12,11 @@ Next, you must decide if you would like authentication to be enabled. For produc
1212

1313
Without User Accounts
1414
---------------------
15-
Open the docker-compose file and add the following environment variable to the server:
15+
Start the docker containers with ``docker-compose run`` :
1616

1717
.. code-block:: bash
1818
19-
NODE_ENV=default
20-
21-
and delete the volume for the server's keys (used for signing JWTs):
22-
23-
.. code-block:: bash
24-
25-
- "${TOKEN_KEYS_DIR}:/token_keys"
26-
27-
Next, start the docker containers with
28-
29-
.. code-block:: bash
30-
31-
docker-compose up
19+
docker-compose --file docker-compose.yml run -p 8888:8888 -p 8889:8889 -e "NODE_ENV=default" server
3220
3321
User Authentication Enabled
3422
---------------------------
@@ -41,11 +29,11 @@ First, generate a public and private key pair
4129
openssl rsa -in deepforge_keys/private_key -pubout > deepforge_keys/public_key
4230
export TOKEN_KEYS_DIR="$(pwd)/deepforge_keys"
4331
44-
Then start DeepForge using docker-compose:
32+
Then start DeepForge using ``docker-compose run``:
4533

4634
.. code-block:: bash
4735
48-
docker-compose up
36+
docker-compose --file docker-compose.yml run -v "${TOKEN_KEYS_DIR}:/token_keys" -p 8888:8888 -p 8889:8889 server
4937
5038
Finally, create the admin user by connecting to the server's docker container. First, get the ID of the container using:
5139

0 commit comments

Comments
 (0)