Skip to content

Commit

Permalink
Administration Landing Page for after server setup (#319)
Browse files Browse the repository at this point in the history
  • Loading branch information
olijeffers0n authored Mar 15, 2024
1 parent af0fe0b commit dbb2ee1
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 3 deletions.
1 change: 1 addition & 0 deletions config/sidebar.paper.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ const paper: SidebarsConfig = {
},
items: [
"admin/getting-started/getting-started",
"admin/getting-started/setup-next-steps",
"admin/getting-started/adding-plugins",
"admin/getting-started/migration",
],
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions docs/paper/admin/getting-started/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Click on the build number to download a file.
To run the server you will need to either create a startup script
or run a command in your terminal.

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

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

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

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

Paper is a drop in replacement for both CraftBukkit and Spigot, you don't need to make any changes.

## Next Steps

Take a look at our [Next Steps](/paper/next-steps) guide to get your server up and running with the best performance and
features.
65 changes: 65 additions & 0 deletions docs/paper/admin/getting-started/setup-next-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
slug: /next-steps
description: How to proceed after starting your server.
---

# Next Steps

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.

## Configuration

One of the first things you should do is ensure your server is configured to your specifications.
Paper is highly configurable, and you can change many settings to suit your needs. We outline where
you can find these settings in the [Configuration](/paper/reference/configuration) guide.

## Plugins

One of the main reasons to use Paper is to take advantage of the many plugins which make use of our
expansive API. We have our own plugin repository, [Hangar](https://hangar.papermc.io/), where you can
find many plugins to use on your server. We also have a guide on how to install plugins
[here](/paper/adding-plugins).

![Hangar](./assets/hangar.png)

## Security

### Whitelisting

If you want to restrict who can join your server, you can use the whitelist feature. This allows you to
specify who can join your server, and stops anyone else from joining. You can use the whitelist from
the server console, or by editing the `whitelist.json` file in your server directory.

### Permissions

Permissions are a way to control what players can and cannot do on your server. You can use permissions
to restrict who can use certain commands, or who can access certain areas of your server. It is
common for plugins to use permissions to control who can use their features. You can use permission
plugins such as [LuckPerms](https://luckperms.net/) to manage the permissions which players will be granted.

## Backups

It's important to keep backups of your server. If something goes wrong, you can restore your server to a
previous state. We cover how to do this in the [Updating](/paper/updating) guide.

## Optimization

Out of the box, Paper is optimized for performance. However, there are many things you can do to further
optimize your server. One of the most common things to do is to make sure that you are running the
correct startup flags for your server. We have a tool that allows you to automatically generate a
startup script with the correct flags for your server. You can find this tool
[here](/misc/tools/start-script-gen). Beyond this, a guide such as [this one](https://paper-chan.moe/paper-optimization/)
will help you to further optimize your server.

## Making your server public

If you want to make your server public, you will need to port forward your server. This allows people
from outside your network to connect to your server. There is a guide made by
[NordVPN](https://nordvpn.com/blog/open-ports-on-router/) which explains what port forwarding is and how
to do it for your Paper server.

## Troubleshooting

If you encounter any issues with your server, you can follow our [Troubleshooting](/paper/basic-troubleshooting)
guide to help you diagnose and fix the issue. If you are unable to fix the issue, you can come and
ask for help in our [Discord](https://discord.gg/papermc) server!
9 changes: 8 additions & 1 deletion docs/paper/admin/how-to/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@ replace any JAR in a running server, be that plugins, or Paper itself.
This is the most important step, and yet the most frequently skipped. While it is unlikely that
updating Paper itself will cause any issues requiring you to restore from a backup, plugin
malfunctions or other accidents might! Updating is a great time to work in a backup. Having
functioning backups is essential to every server, big or small.
functioning backups is essential to every server, big or small. The main things to back up are:

- The world folders
- Server Configuration Files
- Plugin Configuration Files & Plugin JARs

You should aim to have backups from multiple times, and keep them in a safe place. A common approach
is to keep rolling backups, so you always have a certain number of backups from a set amount of time.

## Step 2. Update Plugins

Expand Down

0 comments on commit dbb2ee1

Please sign in to comment.