FoundKey/.config/example.yml

141 lines
3.4 KiB
YAML
Raw Normal View History

2018-07-14 14:14:24 +00:00
name: example-instance-name # Name of your instance
description: example-description # Description of your instance
2018-06-15 04:58:09 +00:00
maintainer:
2018-07-14 14:14:24 +00:00
name: example-maitainer-name # Your name
url: http://example.com/ # Your contact (http or mailto)
repository_url: https://github.com/syuilo/misskey # Repository URL
feedback_url: https://github.com/syuilo/misskey/issues # Feedback URL (e.g. github issue)
2018-07-14 17:09:55 +00:00
# URL and Port settings overview
2018-07-14 17:11:56 +00:00
# e.g., If you want to realize following structure:
2018-07-14 17:09:55 +00:00
#
2018-07-14 17:17:45 +00:00
# +--- https://example.com:123 ----------+
# +------+ |+-------------+ +---------------+|
# | User | ---> || Proxy (123) | ---> | Misskey (456) ||
# +------+ |+-------------+ +---------------+|
# +--------------------------------------+
2018-07-14 17:09:55 +00:00
#
# You need to set 'https://example.com:123' to 'url' prop and
# You need to set 456 to 'port' prop.
2018-07-14 17:15:45 +00:00
#
# In other words, the 'url' prop should be the final accessible URL seen by a user.
2018-07-14 17:16:35 +00:00
# 'port' prop is a port that the Misskey server should actually listen
# on and it is not necessarily the port that a user accesses.
2018-07-14 17:09:55 +00:00
2018-07-14 13:42:44 +00:00
url: http://localhost/
2018-07-14 14:20:30 +00:00
# A port that your Misskey server should listen.
# This value is not a port to use when accessing with a browser.
2018-07-14 13:42:44 +00:00
port: 80
mongodb:
host: localhost
port: 27017
2018-07-14 17:29:50 +00:00
db: misskey
2018-07-14 13:42:44 +00:00
user: example-misskey-user
pass: example-misskey-pass
redis:
host: localhost
port: 6379
2018-07-14 14:14:24 +00:00
pass: example-pass
2018-07-21 10:17:15 +00:00
# Drive capacity of a local user (MB)
localDriveCapacityMb: 256
# Drive capacity of a remote user (MB)
remoteDriveCapacityMb: 8
2018-07-14 13:42:44 +00:00
# If enabled:
# Server will not cache remote files (Using direct link instead).
# You can save your storage.
2018-08-15 22:31:58 +00:00
#
# NOTE:
# * Users cannot see remote images when they turn off "Show media from a remote server" setting.
# * Since thumbnails are not provided, traffic increases.
2018-08-15 16:20:52 +00:00
preventCacheRemoteFiles: false
2018-07-14 14:06:46 +00:00
2018-07-23 16:58:11 +00:00
drive:
storage: 'db'
# OR
2018-07-24 23:01:12 +00:00
# storage: 'minio'
2018-07-23 16:58:11 +00:00
# bucket:
# prefix:
# config:
# endPoint:
# port:
2018-08-13 16:57:52 +00:00
# useSSL:
2018-07-23 16:58:11 +00:00
# accessKey:
# secretKey:
2018-07-26 08:42:08 +00:00
# S3 example
# storage: 'minio'
# bucket: bucket-name
# prefix: files
# config:
# endPoint: s3-us-west-2.amazonaws.com
# region: us-west-2
2018-08-13 16:57:52 +00:00
# useSSL: true
2018-07-26 08:42:08 +00:00
# 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
2018-08-13 16:57:52 +00:00
# useSSL: true
2018-07-26 08:42:08 +00:00
# accessKey: XXX
# secretKey: YYY
2018-07-14 14:06:46 +00:00
#
# Below settings are optional
#
# TLS
# https:
# # path for certification
# key: example-tls-key
# cert: example-tls-cert
2018-07-14 14:06:46 +00:00
2018-07-14 17:22:02 +00:00
# Elasticsearch
# elasticsearch:
# host: localhost
# port: 9200
# pass: null
2018-07-18 15:04:09 +00:00
# reCAPTCHA
# recaptcha:
# site_key: example-site-key
# secret_key: example-secret-key
2018-07-14 14:06:46 +00:00
# ServiceWorker
# sw:
# # Public key of VAPID
# public_key: example-sw-public-key
2018-07-14 14:06:46 +00:00
# # Private key of VAPID
# private_key: example-sw-private-key
2018-07-14 14:06:46 +00:00
# google_maps_api_key: example-google-maps-api-key
2018-07-14 14:06:46 +00:00
# Twitter integration
2018-08-14 13:45:36 +00:00
# You need to set the oauth callback url as : https://<your-misskey-instance>/api/tw/cb
# twitter:
# consumer_key: example-twitter-consumer-key
# consumer_secret: example-twitter-consumer-secret-key
# Ghost
# Ghost account is an account used for the purpose of delegating
# followers when putting users in the list.
# ghost: user-id-of-your-ghost-account
# Clustering
# clusterLimit: 1