From f03910d6bbf1356e7f8da55f8321dc889b19018f Mon Sep 17 00:00:00 2001
From: Bastien Abadie <abadie@teklia.com>
Date: Thu, 21 Mar 2024 09:54:27 +0000
Subject: [PATCH] A bit more documentation for migration towards new setup
---
Makefile | 7 +++++++
README.md | 5 +++++
2 files changed, 12 insertions(+)
diff --git a/Makefile b/Makefile
index 75c24b64ea..59bba8b8a7 100644
--- a/Makefile
+++ b/Makefile
@@ -51,6 +51,13 @@ release:
git tag $(version)
git push origin master $(version)
+clean-docker:
+ $(eval containers:=$(shell docker ps -a -q))
+ @if [ -n "$(containers)" ]; then \
+ echo "Cleaning up past containers\n" \
+ docker rm -f $(containers) ; \
+ fi
+
stack: docker/ssl/ark-cert.pem
docker compose -p arkindex up --build
diff --git a/README.md b/README.md
index f7dcbf12b5..0605a0fb5f 100644
--- a/README.md
+++ b/README.md
@@ -111,6 +111,7 @@ At the root of the repository is a Makefile that provides commands for common op
* `make` or `make all`: Clean and build;
* `make base`: Create and push the `arkindex-base` Docker image that is used to build the `arkindex-app` image;
* `make clean`: Cleanup the Python package build and cache files;
+* `make clean-docker`: Deletes all running containers to avoid naming and network ports conflicts;
* `make build`: Build the arkindex Python package and recreate the `arkindex-app:latest` without pushing to the GitLab container registry;
* `make test-fixtures`: Create the unit tests fixtures on a temporary PostgreSQL database and save them to the `data.json` file used by most Django unit tests.
@@ -205,3 +206,7 @@ docker volume create arkindex_miniodata
mv /usr/share/arkindex/s3/data/iiif /var/lib/docker/volumes/arkindex_miniodata/_data/uploads
mv /usr/share/arkindex/s3/data/{export,iiif-cache,ponos-logs,ponos-artifacts,staging,thumbnails,training} /var/lib/docker/volumes/arkindex_miniodata/_data/
```
+
+You will also need to setup [mkcert](https://github.com/FiloSottile/mkcert?tab=readme-ov-file#installation) as we do not use Teklia development Certificate Authority anymore. `mkcert` will take care of SSL certificates automatically, updating your browsers and system certificate store !
+
+Finally, you can remove the `architecture` project from your work folder, as it's now archived and could be confusing.
--
GitLab