docs: add AGENTS.md and rewrite readme
This commit is contained in:
2 files changed
+45
-11
No files matched your search
@@ -1,14 +1,18 @@
|
||||
# Install
|
||||
apt install python-dev libmysqlclient-dev python-virtualenv
|
||||
python -m venv venv
|
||||
. venv/bin/activate
|
||||
pip install -r requirements.txt
|
||||
# django-postfix-dovecot-api
|
||||
|
||||
# Deploy
|
||||
First you need to have your public key in `/home/gitdeploy/.ssh/authorized_keys` on the server and then you can do:
|
||||
REST API for managing the virtual domains, users and aliases that Postfix and Dovecot read from the database.
|
||||
Used by [mailadmin](https://git.neuf.no/edb/mailadmin).
|
||||
|
||||
fab deploy
|
||||
## Development
|
||||
|
||||
# Inspiration:
|
||||
- http://modoboa.readthedocs.org/
|
||||
- https://github.com/lgunsch/django-vmail
|
||||
```sh
|
||||
mise install
|
||||
uv sync
|
||||
prek install
|
||||
uv run python manage.py migrate
|
||||
uv run python manage.py runserver
|
||||
uv run pytest
|
||||
```
|
||||
|
||||
API docs are served at `/api/docs`. Override settings (database, secret key, Sentry) in
|
||||
`dpdapisite/local_settings.py`.
|
||||
Reference in new issue
Block a user