Skip to content

Commit dbb2ee1

Browse files
authored
Administration Landing Page for after server setup (#319)
1 parent af0fe0b commit dbb2ee1

File tree

5 files changed

+81
-3
lines changed

5 files changed

+81
-3
lines changed

config/sidebar.paper.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ const paper: SidebarsConfig = {
2121
},
2222
items: [
2323
"admin/getting-started/getting-started",
24+
"admin/getting-started/setup-next-steps",
2425
"admin/getting-started/adding-plugins",
2526
"admin/getting-started/migration",
2627
],
260 KB
Loading

docs/paper/admin/getting-started/getting-started.mdx

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Click on the build number to download a file.
3333
To run the server you will need to either create a startup script
3434
or run a command in your terminal.
3535

36-
You can generate a startup script using our [Startup Script Generator](/misc/tools/start-script-gen).
36+
You can generate a startup script using our [Startup Script Generator](/misc/tools/start-script-gen).
3737
You can also obtain the optimized terminal command to run the server there.
3838

3939
If you're just looking for a short command:
@@ -43,7 +43,7 @@ java -Xmx4G -Xms4G -jar paper.jar --nogui
4343
Ensure you navigated your terminal to the directory of your server
4444
and that you have replaced `paper.jar` with the name of the jar you have downloaded.
4545

46-
The amount of RAM can be set by changing the numbers in the `Xmx` and `Xms` arguments.
46+
The amount of RAM can be set by changing the numbers in the `Xmx` and `Xms` arguments.
4747
`--nogui` disables Vanilla's GUI, so you don't get double interfaces when using the command line.
4848

4949
To configure your server, see the [Global Configuration](../reference/configuration/global-configuration.mdx) and
@@ -66,3 +66,8 @@ Paper will handle this conversion for you automatically. No additional considera
6666
### From CraftBukkit or Spigot
6767

6868
Paper is a drop in replacement for both CraftBukkit and Spigot, you don't need to make any changes.
69+
70+
## Next Steps
71+
72+
Take a look at our [Next Steps](/paper/next-steps) guide to get your server up and running with the best performance and
73+
features.
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
slug: /next-steps
3+
description: How to proceed after starting your server.
4+
---
5+
6+
# Next Steps
7+
8+
Now that you have your server up and running, there are a few things you should do to ensure that your server is running smoothly.
9+
10+
## Configuration
11+
12+
One of the first things you should do is ensure your server is configured to your specifications.
13+
Paper is highly configurable, and you can change many settings to suit your needs. We outline where
14+
you can find these settings in the [Configuration](/paper/reference/configuration) guide.
15+
16+
## Plugins
17+
18+
One of the main reasons to use Paper is to take advantage of the many plugins which make use of our
19+
expansive API. We have our own plugin repository, [Hangar](https://hangar.papermc.io/), where you can
20+
find many plugins to use on your server. We also have a guide on how to install plugins
21+
[here](/paper/adding-plugins).
22+
23+
![Hangar](./assets/hangar.png)
24+
25+
## Security
26+
27+
### Whitelisting
28+
29+
If you want to restrict who can join your server, you can use the whitelist feature. This allows you to
30+
specify who can join your server, and stops anyone else from joining. You can use the whitelist from
31+
the server console, or by editing the `whitelist.json` file in your server directory.
32+
33+
### Permissions
34+
35+
Permissions are a way to control what players can and cannot do on your server. You can use permissions
36+
to restrict who can use certain commands, or who can access certain areas of your server. It is
37+
common for plugins to use permissions to control who can use their features. You can use permission
38+
plugins such as [LuckPerms](https://luckperms.net/) to manage the permissions which players will be granted.
39+
40+
## Backups
41+
42+
It's important to keep backups of your server. If something goes wrong, you can restore your server to a
43+
previous state. We cover how to do this in the [Updating](/paper/updating) guide.
44+
45+
## Optimization
46+
47+
Out of the box, Paper is optimized for performance. However, there are many things you can do to further
48+
optimize your server. One of the most common things to do is to make sure that you are running the
49+
correct startup flags for your server. We have a tool that allows you to automatically generate a
50+
startup script with the correct flags for your server. You can find this tool
51+
[here](/misc/tools/start-script-gen). Beyond this, a guide such as [this one](https://paper-chan.moe/paper-optimization/)
52+
will help you to further optimize your server.
53+
54+
## Making your server public
55+
56+
If you want to make your server public, you will need to port forward your server. This allows people
57+
from outside your network to connect to your server. There is a guide made by
58+
[NordVPN](https://nordvpn.com/blog/open-ports-on-router/) which explains what port forwarding is and how
59+
to do it for your Paper server.
60+
61+
## Troubleshooting
62+
63+
If you encounter any issues with your server, you can follow our [Troubleshooting](/paper/basic-troubleshooting)
64+
guide to help you diagnose and fix the issue. If you are unable to fix the issue, you can come and
65+
ask for help in our [Discord](https://discord.gg/papermc) server!

docs/paper/admin/how-to/update.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,14 @@ replace any JAR in a running server, be that plugins, or Paper itself.
2121
This is the most important step, and yet the most frequently skipped. While it is unlikely that
2222
updating Paper itself will cause any issues requiring you to restore from a backup, plugin
2323
malfunctions or other accidents might! Updating is a great time to work in a backup. Having
24-
functioning backups is essential to every server, big or small.
24+
functioning backups is essential to every server, big or small. The main things to back up are:
25+
26+
- The world folders
27+
- Server Configuration Files
28+
- Plugin Configuration Files & Plugin JARs
29+
30+
You should aim to have backups from multiple times, and keep them in a safe place. A common approach
31+
is to keep rolling backups, so you always have a certain number of backups from a set amount of time.
2532

2633
## Step 2. Update Plugins
2734

0 commit comments

Comments
 (0)