Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
111 lines (86 loc) 路 4.82 KB
/
Copy path.env.example
File metadata and controls
111 lines (86 loc) 路 4.82 KB
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
############################### - Global Settings
# Required: The domain where the web application is hosted
WEB_DOMAIN=sunrise.local
############################### - Sunrise Settings
# Required: Secret key for API token generation.
SUNRISE_API_TOKEN_SECRET=
# Required: The port number the sunrise server will listen on
SUNRISE_SERVER_PORT=3912
# Required: The password for the MySQL database
SUNRISE_MYSQL_PASSWORD=root
# Required: The name of the MySQL database
SUNRISE_MYSQL_DATABASE=sunrise
# Required: The port number of the MySQL database
SUNRISE_MYSQL_PORT=3306
# Optional: Used only for local DNS over HTTPS. If you are planning to broadcast your server over the internet, feel free to leave it empty.
SUNRISE_KESTREL_CERTIFICATES_DEFAULT_PASSWORD=
# Optional: Whether to use Cloudflare headers for geolocation (You need to enable both "IP geolocation" and "Add visitor location headers" in Cloudflare for this to work)
SUNRISE_USE_CLOUDFLARE_HEADERS_FOR_GEOLOCATION=
# Optional: If you want to demote superuser on startup, change this variable to `true`. Don't forget to change it after you logged in!
SUNRISE_DEMOTE_SUPERUSER_ON_STARTUP_USE_THIS_IF_SOMEONE_STOLEN_YOUR_SUPERUSER_ACCOUNT=
##############################################################################
# Don't forget to create and edit Sunrise.Config.Production.json config file #
##############################################################################
############################### - Observatory Settings
# Optional: Enter the db username
OBSERVATORY_POSTGRES_USER=admin
# Optional: Enter the db password
OBSERVATORY_POSTGRES_PASSWORD=admin
# Optional: Enter the db name
OBSERVATORY_POSTGRES_DB=observatory
# Optional: Enter the db port
OBSERVATORY_POSTGRES_PORT=5432
# Optional: Enter the client ID
OBSERVATORY_BANCHO_CLIENT_ID=
# Optional: Enter the client secret
OBSERVATORY_BANCHO_CLIENT_SECRET=
# Required: The port number the observatory service will listen on
OBSERVATORY_PORT=3333
# Optional: Providing this string as Authorization header will ignore server's rate limit
OBSERVATORY_IGNORE_RATELIMIT_KEY=
# Optional: How much API calls can be requested per time window; Default: 100
OBSERVATORY_RATELIMIT_CALLS_PER_WINDOW=100
# Optional: How long in milliseconds is time window; Default: 20 seconds
OBSERVATORY_RATELIMIT_TIME_WINDOW=20000
# Optional: How long in hours should .osz files be valid; Default: 24 hours;
OBSERVATORY_OSZ_FILES_LIFE_SPAN=
# Optional: If you need to disable one of the mirrors from usage, enters it's short name here.
# Options: 'mino' | 'bancho' | 'direct' | 'gatari' | 'nerinyan' | 'osulabs';
OBSERVATORY_MIRRORS_TO_IGNORE="someserver,otherserver,osulabs"
# Optional: By default, we use only 90% of the available APIs ratelimits to not get any hard restrictions. Add 'true' to disable this behaviour for better performance.
OBSERVATORY_DISABLE_SAFE_RATELIMIT_MODE=
# Optional: Add 'true' to ignore all daily ratelimits.
OBSERVATORY_DISABLE_DAILY_RATE_LIMIT=
# Optional: Enable this if you are having problems with a disk space due to the database. Add 'true' to enable.
OBSERVATORY_ENABLE_CRON_TO_CLEAR_OUTDATED_BEATMAPS=
# Optional: By default, internal values (like each mirror's usage ratelimits, env values, etc.) are hidden in the /stats endpoint. Add 'true' to enable.
OBSERVATORY_SHOW_INTERNAL_VALUES_IN_PUBLIC_STATS_ENDPOINT=
# Optional: Add 'true' to use US catboy server as the only source of beatmap data. Use this if you have problems with catboy.best (mino) mirror.
OBSERVATORY_USE_US_CATBOY_SERVER_ONLY=
############################### - Sunset Settings
# Required: The port number the sunset web application will listen on.
SUNSET_PORT=3090
# Optional: URL to your community's Discord server.
SUNSET_NEXT_PUBLIC_DISCORD_LINK=
# Optional: Link to your osu! osu server list page.
SUNSET_NEXT_PUBLIC_OSU_SERVER_LIST_LINK=
# Optional: Your Ko-fi donation page URL.
SUNSET_NEXT_PUBLIC_KOFI_LINK=
# Optional: Your Boosty.to page URL.
SUNSET_NEXT_PUBLIC_BOOSTY_LINK=
# Optional: Your status page link. If you you are using uptime kuma from the docker-compose, you can set it to https://uptime.{WEB_DOMAIN}
SUNSET_NEXT_PUBLIC_STATUS_PAGE_LINK=
# Optional: Set to "true" to show the Sunrise Patcher page in the help section.
SUNSET_NEXT_PUBLIC_PATCHER_PAGE_ENABLED=
# Optional: Set to "true" to disable image optimization.
SUNSET_NEXT_PUBLIC_UNOPTIMIZED_IMAGES=
############################### - Sunshine Settings
# Required: Bot information. Feel free to ignore if you are not planning on using discord bot features
SUNSHINE_DISCORD_TOKEN=
# Optional: Chat channel ID to post new scores.
SUNSHINE_NEW_SCORES_CHANNED_ID=
# Optional: Chat channel ID to post beatmap status updates.
SUNSHINE_BEATMAPS_STATUSES_CHANNED_ID=
############################### - Grafana Settings
# Required: The port number the Grafana service will listen on, default is 3060.
GRAFANA_PORT=3060