Update readme
This commit is contained in:
parent
b691b631e9
commit
f79fe6a6e0
|
@ -8,7 +8,7 @@ set -ex
|
|||
add_fqdn_to_hosts $(get_ip_addr $(hostname)) mail
|
||||
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/MockSMTPServer.py &
|
||||
|
||||
|
|
35
README.md
35
README.md
|
@ -10,26 +10,37 @@ overview of its architecture.
|
|||
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.sh up
|
||||
docker-compose up -d
|
||||
```
|
||||
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
|
||||
`sleep infinity`. Then attach to each of phosphoric-acid, mail and coffee,
|
||||
and start ceod (see 'Running the application', below). Once inside a container,
|
||||
make sure to `cd` into the current working directory on the host.
|
||||
|
||||
To use ceo, run the following inside the phosphoric-acid container:
|
||||
run, and start ceod on each of phosphoric-acid, mail, and coffee container.
|
||||
You can check the containers status using:
|
||||
```sh
|
||||
docker-compose logs -f
|
||||
```
|
||||
login
|
||||
<username is ctdalek, password is krb5>
|
||||
<cd into your directory OUTSIDE the container>
|
||||
. venv/bin/activate
|
||||
|
||||
To use ceo, run the following:
|
||||
```sh
|
||||
docker-compose exec phosphoric-acid bash
|
||||
su ctdalek # optional, to run as normal user
|
||||
kinit ctdalek # password is krb5
|
||||
python -m ceo
|
||||
```
|
||||
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
|
||||
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).
|
||||
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
|
||||
|
|
Loading…
Reference in New Issue