Jakub Sokołowski
e139af9a16
Signed-off-by: Jakub Sokołowski <jakub@status.im> |
||
---|---|---|
.. | ||
Makefile | ||
README.md | ||
service.template |
README.md
Status Mailserver
This folder contains setup for running your own Status Mailserver. It uses Systemd for managing the Status Mailserver service.
The steps it takes are:
- Builds statusd
- Generates
statusd
config - Generates
systemd
service - Starts the service
Usage
To simply configure and start the service run make
.
In order to manage the new statusd
service you use other Makefile
targets:
make info
- Info about servicemake enode
- Get enode addressmake start
- Start the servicemake stop
- Stop the servicemake status
- Check service statusmake enable
- Enable the servicemake disable
- Disable the servicemake logs
- Read the service logsmake clean
- Stop service and remove it
All the above commands are just wrappers around the systemctl
and journalctl
commands.
Settings
All settings are passed through environment variables:
SERVICE_NAME
- Name of thesystemd
service to be created. (Default:statusd
)PUBLIC_IP
- Your IP visible from the internet and advertised by the Mailserver.LISTEN_PORT
- Mailserver TCP & UDP port, by default it's30303
but you might want to use443
.RPC_PORT
- Control port making it possible to use the JSON-RPC API.API_MODULES
- API modules to be made available via theRPC_PORT
.DATA_PATH
- Location of Mailserver storage and keys. (Default:/var/tmp/status-go-mail
)REGISTER_TOPIC
- Mynamic mailserver discovery topic. (Default:whispermail
)MAIL_PASSWORD
- Basic HTTP auth password for mailserver. (Default:status-offline-inbox
)LOG_LEVEL
- Set level of log messages to show. (ERROR
,WARN
,INFO
,DEBUG
,TRACE
)
The generated configuration file end up under ${DATA_PATH}/config.json
.
Known Issues
No journal files were opened due to insufficient permissions.
fromsystemctl
- To see logs of a user systemd service you need to be a member of
systemd-journal
group. - Use:
bash usermod -a -G systemd-journal ${USER}
- To see logs of a user systemd service you need to be a member of