This is an automated email from the ASF dual-hosted git repository.
sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git
The following commit(s) were added to refs/heads/master by this push:
new 49b1fca Typos
49b1fca is described below
commit 49b1fca8ea2e4f86a7b17cbf3865ecfd5da3a058
Author: Sebb <sebb...@users.noreply.github.com>
AuthorDate: Wed May 15 23:46:04 2024 +0100
Typos
---
DOCKER.md | 33 +++++++++++++++++++++++----------
1 file changed, 23 insertions(+), 10 deletions(-)
diff --git a/DOCKER.md b/DOCKER.md
index 2fcc894..3dcf409 100644
--- a/DOCKER.md
+++ b/DOCKER.md
@@ -7,13 +7,15 @@ Build Docker image
==================
Checkout Ponymail Foal from Git:
+```
$ get clone https://github.com/apache/incubator-ponymail-foal.git ponymail-foal
$ cd ponymail-foal
+```
start Docker (e.g. open ~/Applications/Docker.app)
Build the image:
-$ docker compose build pmfoal
+```$ docker compose build pmfoal```
Resolve any issues (e.g. ensure Docker has access to the required
directories), and rebuild
@@ -21,32 +23,41 @@ Start ElasticSearch and the main server
=======================================
Open a new terminal session
-$ cd ponymail-foal
+```
+$ cd ponymail-foal
$ docker compose up
+```
To stop the server, either use ^C, or issue the following in another terminal
session:
-$ docker stop pmfoal-pmfoal-1
+```$ docker stop pmfoal-pmfoal-1```
Setup the ElasticSearch database
================================
This only needs to be done once.
+[The container must already be running.]
Open a new terminal session, start a shell in the container:
+```
$ docker exec -it pmfoal-pmfoal-1 bash
-\# cd tools
-\# python3 setup.py --devel
+# cd tools
+# python3 setup.py --devel
+```
+
+Or you can do it all in one command:
-$ docker exec -it pmfoal-pmfoal-1 bash -c 'cd tools; python3 setup.py --devel'
+```$ docker exec -it pmfoal-pmfoal-1 bash -c 'cd tools; python3 setup.py
--devel'```
Or you can set up the database from the host.
The container must already be running, and the Python packages (as per
tools/requirements.txt)
-muts have been installed.
+must have been installed.
+```
$ cd ponymail-foal; cd tools
$ python3 setup.py --devel
+```
You can then use archiver.py or import-mbox.py to populate the database.
@@ -55,12 +66,14 @@ Start the Ponymail api server
Open a new terminal session, start a shell in the container:
+```
$ docker exec -it pmfoal-pmfoal-1 bash
-\# cd server
-\# python3 main.py --testendpoints
+# cd server
+# python3 main.py --testendpoints
+```
Or you can combine them:
-$ docker exec -it pmfoal-pmfoal-1 bash -c 'cd server; python3 main.py
--testendpoints'
+```$ docker exec -it pmfoal-pmfoal-1 bash -c 'cd server; python3 main.py
--testendpoints'```
Connect to the server
=====================
