You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This section will cover enhanced configuration of the server, which were previously not possible with the admin panel.
12
15
13
16
## Update your own privileges (Using direct database change)
@@ -16,6 +19,7 @@ Before we can access the admin panel, we need to update our own privileges. This
16
19
17
20
For the sake of simplicity, we will use the [DBeaver](https://dbeaver.io/) database management tool, but you can use any other tool that supports MySQL databases.
18
21
22
+
<Steps>
19
23
1. Open DBeaver.
20
24
2. Connect to your database following the instructions below
21
25
:::note
@@ -29,22 +33,23 @@ For the sake of simplicity, we will use the [DBeaver](https://dbeaver.io/) datab
29
33
30
34
3. Open the `Database/sunrise/user` table.
31
35
4. Find your user in the list, and double-click on it's `Privilege` value.
32
-
5. Update it using the following table:
36
+
5. Update it to the new value depending on the privileges you want to have. For example, to have admin privileges, set it to `8`.
37
+
<Asidetitle="Privilege Levels and how to calculate them">
38
+
To calculate the privilege level, you should sum the values of the privileges you want to grant.
33
39
34
-
:::note Privilege Levels and how to calculate them
35
-
To calculate the privilege level, you should sum the values of the privileges you want to grant.
40
+
Current privileges are:
36
41
37
-
Current privileges are:
42
+
-`0` - User
43
+
-`1` - Supporter
44
+
-`2` - Bat (Beatmap Approval Team)
45
+
-`8` - Administrator
46
+
-`16` - Developer
47
+
-`512` - Super User (Can use server maintenance commands)
38
48
39
-
-`0` - User
40
-
-`1` - Supporter
41
-
-`2` - Bat (Beatmap Approval Team)
42
-
-`8` - Administrator
43
-
-`16` - Developer
44
-
-`512` - Super User (Can use server maintenance commands)
49
+
For example, if you want to grant Bat and Administrator privileges, you would sum `2` (Bat) and `8` (Administrator), resulting in `10`.
45
50
46
-
For example, if you want to grant Bat and Administrator privileges, you would sum `2` (Bat) and `8` (Administrator), resulting in `10`.
47
-
:::
51
+
</Aside>
48
52
49
53
6. Click on the `Apply cell changes` button (or press `Ctrl + S`).
50
-
7. Changes will be applied during a minute or so, and you will be able to access the admin panel.
54
+
7. Changes will be applied during a minute or so, and you will be able to access the admin panel.
5. Replace files in the `Sunset/app` and `Sunset/public` directories with the downloaded files following the website instructions.
41
+
</Steps>
38
42
39
43
##### Change server's assets
40
44
@@ -44,12 +48,14 @@ For example, to change the front page mascot image, you can replace `Sunset/publ
44
48
45
49
##### Change the website's colors
46
50
51
+
<Steps>
47
52
1. Use any Tailwind v3 ShadCN UI theme generator, use [any search engine](https://www.google.com/search?q=tailwind+css+v3+shadcn+cn+ui+theme+generator) to find one.
48
-
- For simplicity, we will use [tweakcn.com](https://tweakcn.com/) in this guide.
53
+
- For simplicity, we will use [tweakcn.com](https://tweakcn.com/) in this guide.
49
54
2. Select or manually customize the theme you want.
50
55
3. Click on the `Code` tab and select `Tailwind v3` and `hsl` options.
51
56
4. Press the `Copy` button to copy the code.
52
57
5. Open the `Sunset/app/style.css` file and replace the content with the copied code.
You can get the credentials by registering your application on the [osu! API](https://osu.ppy.sh/home/account/edit).
337
343
338
-
344
+
<Steps>
345
+
1. Go to the [osu! API](https://osu.ppy.sh/home/account/edit) page and find the `OAuth` section.
346
+
347
+
348
+
2. Click on the `New OAuth Application` button or press `Edit` if you already have an application created.
349
+
350
+
- If you are creating a new application, fill the `Application Name` and `Application Callback URLs` fields with any value, as they are not used by the server.
339
351
340
-
352
+
3. Copy the `Client ID` and `Client Secret` values.
8
10
9
11
## Introduction
@@ -25,28 +27,31 @@ Make sure to create a backup of the Sunrise using `!backupdatabase` command in-g
25
27
We are not responsible for any data loss or corruption that may occur during the migration. Please make sure to create backups of all databases before proceeding with the migration.
26
28
:::
27
29
30
+
<Steps>
31
+
28
32
1.**Stop the Server**: Ensure that Sunrise/Observatory/Sunshine containers are not running before making any changes. (Leave databases containers running.)
29
33
30
34
2.**Clone the Solar System repository**: Clone the [Solar System](https://github.com/SunriseCommunity/Solar-System) repository with submodules.
4.**Fill the configuration files**: Fill the configuration files with your previous configuration values.
45
49
46
-
For example, if you were using `appsettings.Production.json` file, you can copy the values from it to the `Sunrise.Config.Production.json` file.
47
-
48
-
For the `.env` file, each value has a prefix of the component it belongs to. For example, `SUNRISE_` prefix is for Sunrise, `OBSERVATORY_` prefix is for Observatory, `SUNSHINE_` prefix is for Sunshine.
50
+
For example, if you were using `appsettings.Production.json` file, you can copy the values from it to the `Sunrise.Config.Production.json` file.
51
+
52
+
For the `.env` file, each value has a prefix of the component it belongs to. For example, `SUNRISE_` prefix is for Sunrise, `OBSERVATORY_` prefix is for Observatory, `SUNSHINE_` prefix is for Sunshine.
Starting from January 6 2026, Sunrise has transitioned to using `.env` files for configuration management.
@@ -24,50 +26,54 @@ This is not a requirement, but it is highly recommended to back up your existing
24
26
To do so, run `!backupdatabase` Bancho command in-game to back up your database. After it's done, continue with this guide.
25
27
:::
26
28
29
+
<Steps>
30
+
27
31
1.**Stop the Server**: Ensure that your Sunrise server is not running before making any changes.
28
32
29
-
If you are running the server using Docker Compose:
33
+
If you are running the server using Docker Compose:
30
34
31
-
```bash
32
-
docker compose -f docker-compose.yml down
33
-
```
35
+
```bash
36
+
docker compose -f docker-compose.yml down
37
+
```
34
38
35
-
Or manually stop the server if you are running it directly.
39
+
Or manually stop the server if you are running it directly.
36
40
37
41
2.**Create a `.env` File**: In the root directory of your Sunrise server, there should be a file named `.env.example`. Create a copy of this file and rename it to `.env`.
38
42
39
-
On Linux or macOS, you can use the following command:
43
+
On Linux or macOS, you can use the following command:
40
44
41
-
```bash
42
-
cp .env.example .env
43
-
```
45
+
```bash
46
+
cp .env.example .env
47
+
```
44
48
45
-
On Windows, you can use:
49
+
On Windows, you can use:
46
50
47
-
```powershell
48
-
copy .env.example .env
49
-
```
51
+
```powershell
52
+
copy .env.example .env
53
+
```
50
54
51
55
3.**Migrate Configuration Values**: Open your existing `appsettings.*.json` files and copy the relevant configuration values to the corresponding variables in the `.env` file.
52
56
53
-
Here is an example mapping of the values from `appsettings.json` to `.env` variables:
57
+
Here is an example mapping of the values from `appsettings.json` to `.env` variables:
Please notice that `Hangfire.ConnectionString` is _deprecated_ and doesn't need to be migrated to `.env` file any more. Use the same connection string as `Database.ConnectionString` instead.
Please notice that `Hangfire.ConnectionString` is _deprecated_ and doesn't need to be migrated to `.env` file any more. Use the same connection string as `Database.ConnectionString` instead.
62
+
:::
59
63
60
64
4.**Save Changes**: After migrating all the necessary values, save the `.env` file.
61
65
62
66
5.**Restart the Server**: Start your Sunrise server again to apply the changes.
63
67
64
-
If you are using Docker Compose:
68
+
If you are using Docker Compose:
65
69
66
-
```bash
67
-
docker compose -f docker-compose.yml up -d --build --remove-orphans
68
-
```
70
+
```bash
71
+
docker compose -f docker-compose.yml up -d --build --remove-orphans
72
+
```
73
+
74
+
Or start the server manually if you are running it directly.
69
75
70
-
Or start the server manually if you are running it directly.
0 commit comments