From 4771ef7720838cf289bbfe29037550b63fe0b23c Mon Sep 17 00:00:00 2001 From: chimiana <chimiana@gmail.com> Date: Tue, 13 Dec 2022 03:34:18 +0000 Subject: [PATCH] instance server admin docker-compose files and docs --- docker/config/default_example.yml | 192 ++++++++++++++++++++++++++++++ docker/config/docker_example.env | 4 + docker/docker-compose.yml | 55 +++++++++ 3 files changed, 251 insertions(+) create mode 100644 docker/config/default_example.yml create mode 100644 docker/config/docker_example.env create mode 100644 docker/docker-compose.yml diff --git a/docker/config/default_example.yml b/docker/config/default_example.yml new file mode 100644 index 000000000..c44e350be --- /dev/null +++ b/docker/config/default_example.yml @@ -0,0 +1,192 @@ +#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +# Calckey configuration +#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ + +# ┌─────┐ +#───┘ URL └───────────────────────────────────────────────────── + +# Final accessible URL seen by a user. +url: https://example.tld/ + +# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE +# URL SETTINGS AFTER THAT! + +# ┌───────────────────────┐ +#───┘ Port and TLS settings └─────────────────────────────────── + +# +# Misskey requires a reverse proxy to support HTTPS connections. +# +# +----- https://example.tld/ ------------+ +# +------+ |+-------------+ +----------------+| +# | User | ---> || Proxy (443) | ---> | Misskey (3000) || +# +------+ |+-------------+ +----------------+| +# +---------------------------------------+ +# +# You need to set up a reverse proxy. (e.g. nginx) +# An encrypted connection with HTTPS is highly recommended +# because tokens may be transferred in GET requests. + +# The port that your Misskey server should listen on. +port: 3000 + +# ┌──────────────────────────┐ +#───┘ PostgreSQL configuration └──────────────────────────────── + +db: + host: calckey_db_1 # replace with your db container name + port: 5432 + + # Database name + db: calckey + + # Auth + user: example-calckey-user + pass: example-calckey-pass + + # Whether disable Caching queries + #disableCache: true + + # Extra Connection options + #extra: + # ssl: true + +# ┌─────────────────────┐ +#───┘ Redis configuration └───────────────────────────────────── + +redis: + host: calckey_redis_1 # replace with your redis container name + port: 6379 + #family: 0 # 0=Both, 4=IPv4, 6=IPv6 + #pass: example-pass + #prefix: example-prefix + #db: 1 + +# ┌─────────────────────────────┐ +#───┘ Elasticsearch configuration └───────────────────────────── + +#elasticsearch: +# host: localhost # replace with your elasticsearch container name +# port: 9200 +# ssl: false +# user: +# pass: + +# ┌───────────────┐ +#───┘ ID generation └─────────────────────────────────────────── + +# You can select the ID generation method. +# You don't usually need to change this setting, but you can +# change it according to your preferences. + +# Available methods: +# aid ... Short, Millisecond accuracy +# meid ... Similar to ObjectID, Millisecond accuracy +# ulid ... Millisecond accuracy +# objectid ... This is left for backward compatibility + +# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE +# ID SETTINGS AFTER THAT! + +id: 'aid' + +# ┌─────────────────────┐ +#───┘ Other configuration └───────────────────────────────────── + +# Whether disable HSTS +#disableHsts: true + +# Number of worker processes +#clusterLimit: 1 + +# Job concurrency per worker +# deliverJobConcurrency: 128 +# inboxJobConcurrency: 16 + +# Job rate limiter +# deliverJobPerSec: 128 +# inboxJobPerSec: 16 + +# Job attempts +# deliverJobMaxAttempts: 12 +# inboxJobMaxAttempts: 8 + +# IP address family used for outgoing request (ipv4, ipv6 or dual) +#outgoingAddressFamily: ipv4 + +# Syslog option +#syslog: +# host: localhost +# port: 514 + +# Proxy for HTTP/HTTPS +#proxy: http://127.0.0.1:3128 + +#proxyBypassHosts: [ +# 'example.com', +# '192.0.2.8' +#] + +# Proxy for SMTP/SMTPS +#proxySmtp: http://127.0.0.1:3128 # use HTTP/1.1 CONNECT +#proxySmtp: socks4://127.0.0.1:1080 # use SOCKS4 +#proxySmtp: socks5://127.0.0.1:1080 # use SOCKS5 + +# Media Proxy +#mediaProxy: https://example.com/proxy + +# Proxy remote files (default: false) +#proxyRemoteFiles: true + +#allowedPrivateNetworks: [ +# '127.0.0.1/32' +#] + +# Upload or download file size limits (bytes) +#maxFileSize: 262144000 + +# Managed hosting settings +# !!!!!!!!!! +# >>>>>> NORMAL SELF-HOSTERS, STAY AWAY! <<<<<< +# >>>>>> YOU DON'T NEED THIS! <<<<<< +# !!!!!!!!!! +# Each category is optional, but if each item in each category is mandatory! +# If you mess this up, that's on you, you've been warned... + +#maxUserSignups: 100 +#isManagedHosting: true +#deepl: +# managed: true +# authKey: '' +# isPro: false +# +#email: +# managed: true +# address: 'example@email.com' +# host: 'email.com' +# port: 587 +# user: 'example@email.com' +# pass: '' +# useImplicitSslTls: false +# +#objectStorage: +# managed: true +# baseUrl: '' +# bucket: '' +# prefix: '' +# endpoint: '' +# region: '' +# accessKey: '' +# secretKey: '' +# useSsl: true +# connnectOverProxy: false +# setPublicReadOnUpload: true +# s3ForcePathStyle: true + +# !!!!!!!!!! +# >>>>>> AGAIN, NORMAL SELF-HOSTERS, STAY AWAY! <<<<<< +# >>>>>> YOU DON'T NEED THIS, ABOVE SETTINGS ARE FOR MANAGED HOSTING ONLY! <<<<<< +# !!!!!!!!!! + +# Seriously. Do NOT fill out the above settings if you're self-hosting. +# They're much better off being set from the control panel. diff --git a/docker/config/docker_example.env b/docker/config/docker_example.env new file mode 100644 index 000000000..fdd7e3108 --- /dev/null +++ b/docker/config/docker_example.env @@ -0,0 +1,4 @@ +# db settings +POSTGRES_PASSWORD=example-calckey-pass +POSTGRES_USER=example-calckey-user +POSTGRES_DB=calckey diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml new file mode 100644 index 000000000..826a239ee --- /dev/null +++ b/docker/docker-compose.yml @@ -0,0 +1,55 @@ +version: "3" + +services: + web: + image: docker.io/thatonecalculator/calckey + restart: unless-stopped + depends_on: + - db + - redis +# - es + ports: + - "3000:3000" + networks: + - calcnet +# - web + environment: + NODE_ENV: production + volumes: + - ./files:/calckey/files + - ./config:/calckey/.config:ro + + redis: + restart: unless-stopped + image: docker.io/redis:7.0-alpine + networks: + - calcnet + volumes: + - ./redis:/data + + db: + restart: unless-stopped + image: docker.io/postgres:12.2-alpine + networks: + - calcnet + env_file: + - config/docker.env + volumes: + - ./db:/var/lib/postgresql/data + +# es: +# restart: unless-stopped +# image: docker.elastic.co/elasticsearch/elasticsearch-oss:6.4.2 +# environment: +# - "ES_JAVA_OPTS=-Xms512m -Xmx512m" +# - "TAKE_FILE_OWNERSHIP=111" +# networks: +# - calcnet +# volumes: +# - ./elasticsearch:/usr/share/elasticsearch/data + +networks: + calcnet: + # web: + # external: + # name: web