DNTSK/later42
DNTSK/later42
1
0
Fork 0
Code Pull Requests Packages Projects Releases Wiki Activity

Add readme

Browse Source
This commit is contained in:
Silver Ghost 2022-11-18 14:25:19 +03:00
parent e9559a5fca
commit 553dd63b16
No known key found for this signature in database
2 changed files with 46 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Readme.md Normal file
View File

@ -0,0 +1,37 @@
# Later42
![License](https://img.shields.io/github/license/dntsk/later42) [![Build Status](https://ci.lyalyuev.info/api/badges/dntsk/later42/status.svg)](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.

9
SECURITY.md Normal file
View File

@ -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: |