Deploying Misskey with Docker

1
# Misskey minimal deploy config
2
version: "3"
3

4
services:
5
  web:
6
    restart: always # Automatically restart. If you’re not confident about your config, do NOT enable this to avoid a crash–restart loop that wastes resources!
7
    image: misskey/misskey:latest # Use the official image to avoid issues from insufficient resources during local builds
8
    container_name: misskey_web # Container name for easier management; feel free to change it
9
    links:
10
      - db
11
      - redis
12
    ports:
13
      - "3001:3001"
14
    networks:
15
      - internal_network
16
      - external_network
17
    volumes:
18
      - ./config:/misskey/.config:ro # Map the config directory; name it as you like. Read-only is enough.
19
      - ./files:/misskey/files # Local storage for user uploads. If you use external storage (like Wasabi or AWS S3) from the start, you can skip this.
20

21
  redis:
22
    restart: always
23
    image: redis:latest
24
    container_name: misskey_redis
25
    networks:
26
      - internal_network
27
    volumes:
28
      - ./redis:/data # Redis data directory mapping, defaults to ./redis
29

30
  db:
31
    restart: always
32
    image: postgres:12.2-alpine
33
    container_name: misskey_db
34
    networks:
35
      - internal_network
36
    env_file:
37
      - ./config/docker.env # Use Docker environment variables defined in this file
38
    volumes:
39
      - ./db:/var/lib/postgresql/data # Main database data directory mapping, defaults to ./db
40

41
networks:
42
  internal_network: # Internal network
43
    internal: true
44
  external_network: # External network

1
mkdir config
2
cd config
3
vim default.yml

1
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
2
# Misskey configuration
3
#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
4

5
#   ┌─────┐
6
#───┘ URL └─────────────────────────────────────────────────────
7

8
# Final accessible URL seen by a user.
9
url:        # Be sure to change this to the domain you’ll use behind your reverse proxy
10

11
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
12
# URL SETTINGS AFTER THAT!
13

14
#   ┌───────────────────────┐
15
#───┘ Port and TLS settings └───────────────────────────────────
16

17
#
18
# Misskey requires a reverse proxy to support HTTPS connections.
19
#
20
#                 +----- https://example.tld/ ------------+
21
#   +------+      |+-------------+      +----------------+|
22
#   | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
23
#   +------+      |+-------------+      +----------------+|
24
#                 +---------------------------------------+
25
#
26
#   You need to set up a reverse proxy. (e.g. nginx)
27
#   An encrypted connection with HTTPS is highly recommended
28
#   because tokens may be transferred in GET requests.
29

30
# The port that your Misskey server should listen on.
31
port: 3001
32

33
#   ┌──────────────────────────┐
34
#───┘ PostgreSQL configuration └────────────────────────────────
35

36
db:
37
  host: db
38
  port: 5432
39

40
  # Database name
41
  db: misskey
42

43
  # Auth
44
  user: example-misskey-user
45
  pass: example-misskey-pass
46

47
  # Whether disable Caching queries
48
  #disableCache: true
49

50
  # Extra Connection options
51
  #extra:
52
  #  ssl: true
53

54
#   ┌─────────────────────┐
55
#───┘ Redis configuration └─────────────────────────────────────
56

57
redis:
58
  host: redis
59
  port: 6379
60
  #family: 0  # 0=Both, 4=IPv4, 6=IPv6
61
  #pass: example-pass
62
  #prefix: example-prefix
63
  #db: 1
64

65
#   ┌─────────────────────────────┐
66
#───┘ Elasticsearch configuration └─────────────────────────────
67

68
#elasticsearch:
69
#  host: localhost
70
#  port: 9200
71
#  ssl: false
72
#  user:
73
#  pass:
74

75
#   ┌───────────────┐
76
#───┘ ID generation └───────────────────────────────────────────
77

78
# You can select the ID generation method.
79
# You don't usually need to change this setting, but you can
80
# change it according to your preferences.
81

82
# Available methods:
83
# aid ... Short, Millisecond accuracy
84
# meid ... Similar to ObjectID, Millisecond accuracy
85
# ulid ... Millisecond accuracy
86
# objectid ... This is left for backward compatibility
87

88
# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
89
# ID SETTINGS AFTER THAT!
90

91
id: 'aid'
92

93
#   ┌─────────────────────┐
94
#───┘ Other configuration └─────────────────────────────────────
95

96
# Whether disable HSTS
97
#disableHsts: true
98

99
# Number of worker processes
100
#clusterLimit: 1
101

102
# Job concurrency per worker
103
# deliverJobConcurrency: 128
104
# inboxJobConcurrency: 16
105

106
# Job rate limiter
107
# deliverJobPerSec: 128
108
# inboxJobPerSec: 16
109

110
# Job attempts
111
# deliverJobMaxAttempts: 12
112
# inboxJobMaxAttempts: 8
113

114
# IP address family used for outgoing request (ipv4, ipv6 or dual)
115
#outgoingAddressFamily: ipv4
116

117
# Syslog option
118
#syslog:
119
#  host: localhost
120
#  port: 514
121

122
# Proxy for HTTP/HTTPS
123
#proxy: http://127.0.0.1:3128
124

125
#proxyBypassHosts: [
126
#  'example.com',
127
#  '192.0.2.8'
128
#]
129

130
# Proxy for SMTP/SMTPS
131
#proxySmtp: http://127.0.0.1:3128   # use HTTP/1.1 CONNECT
132
#proxySmtp: socks4://127.0.0.1:1080 # use SOCKS4
133
#proxySmtp: socks5://127.0.0.1:1080 # use SOCKS5
134

135
# Media Proxy
136
#mediaProxy: https://example.com/proxy
137

138
# Proxy remote files (default: false)
139
#proxyRemoteFiles: true
140

141
# Sign to ActivityPub GET request (default: false)
142
#signToActivityPubGet: true
143

144
#allowedPrivateNetworks: [
145
#  '127.0.0.1/32'
146
#]
147

148
# Upload or download file size limits (bytes)
149
#maxFileSize: 262144000

1
docker.env 内容
2
# db settings
3
POSTGRES_PASSWORD=example-misskey-pass
4
POSTGRES_USER=example-misskey-user
5
POSTGRES_DB=misskey

1
启动
2
cd ..    # Go back to the directory containing the docker-compose file
3
docker-compose run --rm web yarn run init   # Initialize the database
4
docker-compose up -d