philorg/sms-handler
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 2 Wiki Activity Actions

Update base url for doc and container
Some checks failed
/ test (push) Failing after 13s
Details

Browse source
This commit is contained in:
phil 2024-12-05 14:59:03 +01:00
parent 1b419164db
commit 12d071075d
4 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTAINER.md
View file

@ -3,13 +3,13 @@
Use `podman` or `docker`:
```sh
podman run registry.philo.ydns.eu/philo/sms-handler
podman run code.philo.ydns.eu/philorg/sms-handler
```
Parameters are given as environment variables, eg.:
```sh
podman run -e SMS_HANDLER_MAIL_SERVER_PORT=8025 -e SMS_HANDLER_MAIL_SENDER=snoopy@peanuts.com SMS_HANDLER_MAIL_TO=snoopy@peanuts.com registry.philo.ydns.eu/philo/sms-handler
podman run -e SMS_HANDLER_MAIL_SERVER_PORT=8025 -e SMS_HANDLER_MAIL_SENDER=snoopy@peanuts.com SMS_HANDLER_MAIL_TO=snoopy@peanuts.com code.philo.ydns.eu/philorg/sms-handler
```
## Container as a systemd service
@ -26,7 +26,7 @@ The configuration is given as environment variables (email addresses `snoopy@pea
ContainerName=sms-handler
Environment=SMS_HANDLER_MAIL_SENDER=snoopy@peanuts.com
Environment=SMS_HANDLER_MAIL_TO=snoopy@peanuts.com
Image=registry.philo.ydns.eu/philo/sms-handler
Image=code.philo.ydns.eu/philorg/sms-handler
Network=podman
PublishPort=8025:8025
@ -64,7 +64,7 @@ For a rootless container, create a file in `/etc/containers/systemd/sms-handler.
ContainerName=sms-handler
Environment=SMS_HANDLER_MAIL_SENDER=snoopy@peanuts.com
Environment=SMS_HANDLER_MAIL_TO=snoopy@peanuts.com
Image=registry.philo.ydns.eu/philo/sms-handler
Image=code.philo.ydns.eu/philorg/sms-handler
Network=podman
PublishPort=8025:8025

2
Containerfile
View file

@ -1,4 +1,4 @@
# Build: podman build -t registry.philo.ydns.eu/philo/sms-handler -f Containerfile
# Build: podman build -t code.philo.ydns.eu/philorg/sms-handler -f Containerfile
FROM docker.io/python:3.12-alpine
COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/

8
README.md
View file

@ -1,6 +1,6 @@
# About sms-handler
[sms-handler](https://philo.ydns.eu/code/Philome/sms-handler) is a simple companion service of the
[sms-handler](https://code.philo.ydns.eu/philorg/sms-handler) is a simple companion service of the
*SMS to URL Forwarder* app available on [F-Droid](https://f-droid.org/en/packages/tech.bogomolov.incomingsmsgateway/),
to send notification mails on reception of SMSes.
@ -10,14 +10,14 @@ or configured as a relay.
## Installation
```sh
PIP_EXTRA_INDEX_URL=https://pypi.org/simple/ pip install --index-url https://philo.ydns.eu/code/api/packages/Philome/pypi/simple/ sms-handler
PIP_EXTRA_INDEX_URL=https://pypi.org/simple/ pip install --index-url https://code.philo.ydns.eu/api/packages/philorg/pypi/simple/ sms-handler
```
Debian and other systems prefer using `pipx` instead of `pip`:
```sh
sudo apt install -y pipx
PIP_EXTRA_INDEX_URL=https://pypi.org/simple/ pipx install --index-url https://philo.ydns.eu/code/api/packages/Philome/pypi/simple/ sms-handler
PIP_EXTRA_INDEX_URL=https://pypi.org/simple/ pipx install --index-url https://code.philo.ydns.eu/api/packages/philorg/pypi/simple/ sms-handler
```
*sms-handler* can be run with any unprivileged user.
@ -142,7 +142,7 @@ the destination IP:port `127.0.0.1:8025` for your setup.
Download source code, create a Python virtual environment, install dependencies and run the tests:
```sh
git clone https://philo.ydns.eu/code/Philome/sms-handler.git
git clone https://code.philo.ydns.eu/philorg/sms-handler.git
cd sms-handler
uv venv
uv sync

2
pyproject.toml
View file

@ -1,6 +1,6 @@
[project]
name = "sms_handler"
version = "0.0.6"
version = "0.0.7"
#dynamic = ["version"]
description = "Listen to messages from the SMS Forwarder app on Android and send mail"
readme = "README.md"