summaryrefslogtreecommitdiff
path: root/.config/example.yml
blob: 0f416ab96fb099c5656995610f8f720788ee5274 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# Final accessible URL seen by a user.
url: https://example.tld/


### Port and TLS settings ######################################
#
# Misskey supports two deployment options for public.
#

# Option 1: With Reverse Proxy
#
#                 +----- https://example.tld/ ------------+
#   +------+      |+-------------+      +----------------+|
#   | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
#   +------+      |+-------------+      +----------------+|
#                 +---------------------------------------+
#
#   You need to setup reverse proxy. (eg. nginx)
#   You do not define 'https' section.

# Option 2: Standalone
#
#                 +- https://example.tld/ -+
#   +------+      |   +---------------+    |
#   | User | ---> |   | Misskey (443) |    |
#   +------+      |   +---------------+    |
#                 +------------------------+
#
#   You need to run Misskey as root.
#   You need to set Certificate in 'https' section.

# To use option 1, uncomment below line.
# port: 3000    # A port that your Misskey server should listen.

# To use option 2, uncomment below lines.
# port: 443
#
# https:
#   # path for certification
#   key: /etc/letsencrypt/live/example.tld/privkey.pem
#   cert: /etc/letsencrypt/live/example.tld/fullchain.pem

################################################################


mongodb:
  host: localhost
  port: 27017
  db: misskey
  user: example-misskey-user
  pass: example-misskey-pass

drive:
  storage: 'db'

  # OR

  # storage: 'minio'
  # bucket:
  # prefix:
  # config:
  #   endPoint:
  #   port:
  #   useSSL:
  #   accessKey:
  #   secretKey:

  # S3 example
  # storage: 'minio'
  # bucket: bucket-name
  # prefix: files
  # config:
  #   endPoint: s3-us-west-2.amazonaws.com
  #   region: us-west-2
  #   useSSL: true
  #   accessKey: XXX
  #   secretKey: YYY

  # S3 example (with CDN, custom domain)
  # storage: 'minio'
  # bucket: drive.example.com
  # prefix: files
  # baseUrl: https://drive.example.com
  # config:
  #   endPoint: s3-us-west-2.amazonaws.com
  #   region: us-west-2
  #   useSSL: true
  #   accessKey: XXX
  #   secretKey: YYY

# If enabled:
#  The first account created is automatically marked as Admin.
autoAdmin: true

#
# Below settings are optional
#

# Redis
#redis:
#  host: localhost
#  port: 6379
#  pass: example-pass

# Elasticsearch
#elasticsearch:
#  host: localhost
#  port: 9200
#  pass: null

# ServiceWorker
#sw:
#  # Public key of VAPID
#  public_key: example-sw-public-key
#
#  # Private key of VAPID
#  private_key: example-sw-private-key

# Clustering
#clusterLimit: 1

# Summaly proxy
#summalyProxy: "http://example.com"

# User recommendation
#user_recommendation:
#  external: true
#  engine: http://vinayaka.distsn.org/cgi-bin/vinayaka-user-match-misskey-api.cgi?{{host}}+{{user}}+{{limit}}+{{offset}}
#  timeout: 300000