public
/
pyceo
27
1
Fork 3
Code Issues 25 Pull Requests 5 Projects Releases 1 Wiki Activity

Update readme

This commit is contained in:
Rio6 2021-09-12 15:20:50 -04:00
parent b691b631e9
commit f79fe6a6e0
2 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.drone/mail-setup.sh
View File

@ -8,7 +8,7 @@ set -ex
add_fqdn_to_hosts $(get_ip_addr $(hostname)) mail add_fqdn_to_hosts $(get_ip_addr $(hostname)) mail
add_fqdn_to_hosts $(get_ip_addr auth1) auth1 add_fqdn_to_hosts $(get_ip_addr auth1) auth1
. venv/bin/activate [ -f venv/bin/activate ] && . venv/bin/activate
python tests/MockMailmanServer.py & python tests/MockMailmanServer.py &
python tests/MockSMTPServer.py & python tests/MockSMTPServer.py &

35
README.md
View File

@ -10,26 +10,37 @@ overview of its architecture.
If you are not modifying code related to email or Mailman, then you may use If you are not modifying code related to email or Mailman, then you may use
Docker containers instead, which are much easier to work with than the VM. Docker containers instead, which are much easier to work with than the VM.
``` ```
docker.sh up docker-compose up -d
``` ```
This will create some containers with the bare minimum necessary for ceod to This will create some containers with the bare minimum necessary for ceod to
run. Run `docker logs -f phosphoric-acid` and wait until you see the line run, and start ceod on each of phosphoric-acid, mail, and coffee container.
`sleep infinity`. Then attach to each of phosphoric-acid, mail and coffee, You can check the containers status using:
and start ceod (see 'Running the application', below). Once inside a container, ```sh
make sure to `cd` into the current working directory on the host. docker-compose logs -f
To use ceo, run the following inside the phosphoric-acid container:
``` ```
login
<username is ctdalek, password is krb5> To use ceo, run the following:
<cd into your directory OUTSIDE the container> ```sh
. venv/bin/activate docker-compose exec phosphoric-acid bash
su ctdalek # optional, to run as normal user
kinit ctdalek # password is krb5
python -m ceo python -m ceo
``` ```
This should bring up the TUI. This should bring up the TUI.
Normally, ceod should autoamtically restart when the source files are changed.
To manually restart the service, run:
```sh
docker-compose kill -s SIGHUP phosphoric-acid
```
To stop the containers, run:
```sh
docker-compose down
```
### VM ### VM
If you are making changes related to email or Mailman, you will need the full If you need the full environment running in VM, follow the guide on
[syscom dev environment](https://git.uwaterloo.ca/csc/syscom-dev-environment). [syscom dev environment](https://git.uwaterloo.ca/csc/syscom-dev-environment).
This will setup all of the services needed for ceo to work. You should clone This will setup all of the services needed for ceo to work. You should clone
this repo in the phosphoric-acid container under ctdalek's home directory; you this repo in the phosphoric-acid container under ctdalek's home directory; you