From b462bec37fd72fd3836b3948e600df21e04b94b4 Mon Sep 17 00:00:00 2001 From: Ian Ward Date: Tue, 8 Oct 2024 17:30:55 -0400 Subject: [PATCH] add warning, remove image of text --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5286e072..3d9c7dd6 100644 --- a/README.md +++ b/README.md @@ -61,10 +61,8 @@ Use this if you are a maintainer and will not be making code changes to CKAN or Copy the included `.env.example` and rename it to `.env`. Modify it depending on your own needs. -Please note that when accessing CKAN directly (via a browser) ie: not going through NGINX you will need to make sure you have "ckan" set up -to be an alias to localhost in the local hosts file. Either that or you will need to change the `.env` entry for `CKAN_SITE_URL` - -Using the default values on the `.env.example` file will get you a working CKAN instance. There is a sysadmin user created by default with the values defined in `CKAN_SYSADMIN_NAME` and `CKAN_SYSADMIN_PASSWORD`(`ckan_admin` and `test1234` by default). This should be obviously changed before running this setup as a public CKAN instance. +> [!WARNING] +> There is a sysadmin user created by default with the values defined in `CKAN_SYSADMIN_NAME` and `CKAN_SYSADMIN_PASSWORD` (`ckan_admin` and `test1234` by default). These must be changed before running this setup as a public CKAN instance. To build the images: @@ -78,11 +76,20 @@ This will start up the containers in the current window. By default the containe using a different colour. You could also use the -d "detach mode" option ie: `docker compose up -d` if you wished to use the current window for something else. -At the end of the container start sequence there should be 6 containers running +At the end of the container start sequence there should be 6 containers running: -![Screenshot 2022-12-12 at 10 36 21 am](https://user-images.githubusercontent.com/54408245/207012236-f9571baa-4d99-4ffe-bd93-30b11c4829e0.png) +```bash +$ docker compose ps +NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS +ckan-docker-ckan-1 ckan-docker-ckan "/srv/app/start_ckan…" ckan 4 minutes ago Up 3 minutes (healthy) 5000/tcp +ckan-docker-datapusher-1 ckan/ckan-base-datapusher:0.0.20 "sh -c 'uwsgi --plug…" datapusher 4 minutes ago Up 4 minutes (healthy) 8800/tcp +ckan-docker-db-1 ckan-docker-db "docker-entrypoint.s…" db 4 minutes ago Up 4 minutes (healthy) +ckan-docker-nginx-1 ckan-docker-nginx "/bin/sh -c 'openssl…" nginx 4 minutes ago Up 2 minutes 80/tcp, 0.0.0.0:8443->443/tcp +ckan-docker-redis-1 redis:6 "docker-entrypoint.s…" redis 4 minutes ago Up 4 minutes (healthy) +ckan-docker-solr-1 ckan/ckan-solr:2.10-solr9 "docker-entrypoint.s…" solr 4 minutes ago Up 4 minutes (healthy) +``` -After this step, CKAN should be running at `CKAN_SITE_URL`. +After this step, CKAN should be running at `CKAN_SITE_URL` (by default https://localhost:8443) ### Development mode