From 553dd63b16102c181e4b539af16d4f39ca6acd93 Mon Sep 17 00:00:00 2001 From: Dmitriy Lyalyuev <dmitriy@lyalyuev.info> Date: Fri, 18 Nov 2022 14:25:19 +0300 Subject: [PATCH] Add readme --- Readme.md | 37 +++++++++++++++++++++++++++++++++++++ SECURITY.md | 9 +++++++++ 2 files changed, 46 insertions(+) create mode 100644 Readme.md create mode 100644 SECURITY.md diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..cdbb3a2 --- /dev/null +++ b/Readme.md @@ -0,0 +1,37 @@ +# Later42 + + [](https://ci.lyalyuev.info/dntsk/later42) + +Selfhostable read it later service. + +## Environment variables + +| Variable | Default | Description +|---------------------|-------------------------|------------ +TZ | UTC | Time zone +DEBUG | False | Enable/disable debug mode +SECRET_KEY | | The secret key to make hashes +DOMAIN | localhost | Domain name where the site is hosted +DB_TYPE | SQLite | Type of DB (SQLite, Postgres) +DB_HOST | None | Host for Postgres DB +DB_NAME | None | Name for Postgres DB +DB_USER | None | User for Postgres DB +DB_PASS | None | Password for Postgres DB +REDIS_URL | redis://localhost:6379 | Connection string for Redis +READABILITY_HOST | http://localhost:8080/ | Connection string for [UReadability](https://github.com/ukeeper/ukeeper-readability) +EMAIL_USE_TLS | False | Enable TLS for SMTP +EMAIL_HOST | smtp | SMTP host +EMAIL_HOST_USER | None | SMTP user +EMAIL_HOST_PASSWORD | None | SMTP password +EMAIL_PORT | 25 | SMTP port +EMAIL_FROM | noreply@later42.com | Email address for From header +AIRBRAKE_PROJECT_ID | None | Airbrake project id +AIRBRAKE_PROJECT_KEY | None | Airbrake project key +AIRBRAKE_ENVIRONMENT | development | Airbrake environment +SENTRY_DSN | None | Sentry DSN to catch errors + +## Contribute + +If you want to report a bug or request a new feature. Free feel to open a new issue or pull request. + +English proofreading is needed, because my grammar is not that great sadly. Feel free to correct my grammar in this Readme or source code. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..1a0fcbc --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,9 @@ +# Security policy + +Please report (suspected) security vulnerabilities to the [GitHub issues](https://github.com/dntsk/later42/issues). If the issue is confirmed, we will release a patch as soon as possible depending on complexity but historically within a few days. + +## Supported Versions for security patches + +| Version | Supported | +| ------- | ------------------ | +| 0.1 | :white_check_mark: |