vrr/readest
2
0
Fork 0
mirror of https://github.com/readest/readest.git synced 2026-05-02 05:21:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

feat(docker/podman): self-hosting with docker/podman compose (#3312)
Some checks failed
Deploy to vercel on merge / build_and_deploy (push) Has been cancelled
Details

Browse source 
* initial files

* added testing files

* removed unused files

* cleaned additional mounts

* fixed sql init

* removed more unused files

* moved to docker folder

* revert package.json

* gitignore update

* env example comments and compose necessary healthcheck

* ghcr package impl

* updated dockerfile steps  for layer caching

* added development-stage to dockerfile to dev environment

* added documentation on how to use dockerfile and compose.yml

* fixed prettier issues

* fixed image tag

* removed workflow for later
This commit is contained in:
Aniket Kotal 2026-02-18 18:58:10 +05:30 • committed by GitHub
parent c6ae85484e
commit eec2c39f19
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 580 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

51
docker/.env.example Normal file
View file

@ -0,0 +1,51 @@
# ip used by frontend/client-side urls to access the backend
HOST_IP=localhost
# db(psql) config
# change to strong password, min 32 chars
POSTGRES_PASSWORD=your-super-secret-postgres-password
POSTGRES_HOST=db
POSTGRES_PORT=5432
POSTGRES_DB=postgres
# jwt config
JWT_EXPIRY=3600
JWT_SECRET=your-super-secret-jwt-token-with-at-least-32-characters
# both ANON_KEY and SERVICE_ROLE_KEY should be generated using the above set secret
# sign this payload -> {"role": "anon"} <- for ANON_KEY with JWT_SECRET
ANON_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYW5vbiJ9.HmbvN-NgnsK1Lbk5e8Dti9SS6SFB384DsIT8QVLwUo8
# sign this payload -> {"role": "service_role"} <- for SERVICE_ROLE_KEY with JWT_SECRET
SERVICE_ROLE_KEY=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic2VydmljZV9yb2xlIn0.ym708-_0SlTjvc0pAK56bXQK2srKAo8RbJfA3czgkFo
KONG_HTTP_PORT=8000
# auth (gotrue)
API_EXTERNAL_URL=http://localhost:8000
SITE_URL=http://localhost:3000
ADDITIONAL_REDIRECT_URLS=http://localhost:3000/**,http://localhost:8000/**
# readest auth stuff
DISABLE_SIGNUP=false
ENABLE_EMAIL_SIGNUP=true
ENABLE_EMAIL_AUTOCONFIRM=true
ENABLE_ANONYMOUS_USERS=false
# only needed if ENABLE_EMAIL_AUTOCONFIRM is false
SMTP_HOST=
SMTP_PORT=587
SMTP_USER=
SMTP_PASS=
SMTP_ADMIN_EMAIL=admin@example.com
SMTP_SENDER_NAME=Readest
# PostgREST shiz
PGRST_DB_SCHEMAS=public,graphql_public
# s3 storage through MinIO
MINIO_ROOT_USER=minioadmin
MINIO_ROOT_PASSWORD=minioadmin-secret-password
S3_BUCKET_NAME=readest-files
# 1GB fixed quota for storage and 50k for translations
STORAGE_FIXED_QUOTA=1073741824
TRANSLATION_FIXED_QUOTA=50000