Plexus/Website
1
0
Fork 0
mirror of https://github.com/plexusorg/Website.git synced 2024-12-22 18:07:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improvements to compiling and Redis instructions

Browse Source
This commit is contained in:
Telesphoreo 2024-12-01 22:25:41 -06:00
parent 24bd8e2017
commit 0220cc3752
2 changed files with 40 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/compiling.mdx
View File

@ -10,8 +10,8 @@ import TabItem from '@theme/TabItem';
Compiling Plex is straightforward as there are no dependencies that need to be added manually. Plex uses Gradle as the build system. All compiling instructions are in the ```build.gradle.kts``` file. Note that you can download an already compiled version of Plex from the [CI Server](https://ci.plex.us.org). Compiling Plex is straightforward as there are no dependencies that need to be added manually. Plex uses Gradle as the build system. All compiling instructions are in the ```build.gradle.kts``` file. Note that you can download an already compiled version of Plex from the [CI Server](https://ci.plex.us.org).
## Prerequisites ## Prerequisites
Please ensure that you have Java 17 installed on your computer, as Plex requires JDK 17 to compile. You will get an error if you try to use an older version. Please ensure that you have Java 21 installed on your computer, as Plex requires JDK 21 to compile. You will get an error if you try to use an older version.
If you have Java 17 installed, it may not be set in your path. If you do not already have Java installed, the recommended place to get Java is from [Adoptium](https://adoptium.net/). In the installer, there is an option to set JDK 17 to your path. **You must select that option if it is not already selected by default.** If you have Java 21 installed, it may not be set in your path. If you do not already have Java installed, the recommended place to get Java is from [Adoptium](https://adoptium.net/). In the installer, there is an option to set JDK 21 to your path. **You must select that option if it is not already selected by default.**
Plex does not require, but recommends having Git installed on your computer. If you do not want to install Git, you may download the source code manually. Git for Windows can be downloaded [here](https://git-scm.com). macOS and Linux users should already have Git installed by default. Plex does not require, but recommends having Git installed on your computer. If you do not want to install Git, you may download the source code manually. Git for Windows can be downloaded [here](https://git-scm.com). macOS and Linux users should already have Git installed by default.
## Using the command line ## Using the command line
@ -32,32 +32,32 @@ cd Plex-master
Gradle is already included in the folder with Plex. Run the following command below based on your operating system to compile Plex. Gradle is already included in the folder with Plex. Run the following command below based on your operating system to compile Plex.
<Tabs> <Tabs>
<TabItem value="macOS" label="macOS" default> <TabItem value="macOS" label="macOS" default>
```bash ```bash
./gradlew build ./gradlew build
``` ```
</TabItem> </TabItem>
<TabItem value="Windows" label="Windows"> <TabItem value="Windows" label="Windows">
```bash ```bash
gradlew.bat build gradlew.bat build
``` ```
</TabItem> </TabItem>
<TabItem value="Linux" label="Linux"> <TabItem value="Linux" label="Linux">
```bash ```bash
./gradlew build ./gradlew build
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
You should receive a message indicating the compilation was successful. The JAR files for the Server and Proxy are located in the `build/libs` folder. You should receive a message indicating the compilation was successful. The JAR files for the Server and Proxy are located in the `build/libs` folder.
Plex has no external dependencies and can be used right away after compilation. Plex works on Minecraft 1.19 to 1.20.4. You also must be running Java 17 on the server itself. Plex has no external dependencies and can be used right away after compilation. See [Versions](./versions.md) to see what the compatibility for Plex is. You also must be running Java 21 on the server itself.
## Troubleshooting ## Troubleshooting
If you receive an error that says Permission denied, run `chmod a+x gradlew`. Note that this only applies to macOS / Linux users. If you receive an error that says Permission denied, run `chmod a+x gradlew`. Note that this only applies to macOS / Linux users.

24
docs/redis.md → docs/redis.mdx
View File

@ -3,6 +3,9 @@ id: redis
title: Configuring Redis title: Configuring Redis
--- ---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Redis # Redis
This page will show you how to setup and configure Redis for Plex. This tutorial assumes a moderate amount of computer knowledge. Please note that setting up Redis is optional. It offers many performance improvements, but can be dangerous if improperly configured. This page will show you how to setup and configure Redis for Plex. This tutorial assumes a moderate amount of computer knowledge. Please note that setting up Redis is optional. It offers many performance improvements, but can be dangerous if improperly configured.
@ -10,7 +13,7 @@ This page will show you how to setup and configure Redis for Plex. This tutorial
If you are using Pterodactyl, setting up Redis is easy. You will need to download and add the Redis egg, which requires administrator privileges. If you are not an administrator, you may request an administrator to set up Redis for you. If you are using Pterodactyl, setting up Redis is easy. You will need to download and add the Redis egg, which requires administrator privileges. If you are not an administrator, you may request an administrator to set up Redis for you.
### Setup the Redis egg ### Setup the Redis egg
Right click on [this link](https://docs.plex.us.org/egg-redis-7.json) and click "Save As". Please ensure that the filename ends in .json Right-click on [this link](@site/static/egg-redis-7.json) and click "Save As". Please ensure that the filename ends in .json
On your Pterodactyl admin page, click on the "Nests" from the sidebar. Click the blue "Create New" button and enter "Databases" for the name. On your Pterodactyl admin page, click on the "Nests" from the sidebar. Click the blue "Create New" button and enter "Databases" for the name.
Then, click on the green "Import Egg" button. Import the `egg-redis-7.json` file you just downloaded and make sure the "Associated Nest" is set to "Databases". Then, click on the green "Import Egg" button. Import the `egg-redis-7.json` file you just downloaded and make sure the "Associated Nest" is set to "Databases".
@ -81,5 +84,22 @@ side:
Replace `your_secure_password_here` with the password you made for Redis. Now, Plex will use Redis for storing punishment data. Note that the JSON files are still made as a backup no matter what. Replace `your_secure_password_here` with the password you made for Redis. Now, Plex will use Redis for storing punishment data. Note that the JSON files are still made as a backup no matter what.
### Firewall Configuraton ### Firewall Configuration
If you are using a firewall, you may have to allow port `6380`. It is safe to allow connections from anywhere provided you have followed the documentation correctly. If you are using a firewall, you may have to allow port `6380`. It is safe to allow connections from anywhere provided you have followed the documentation correctly.
<Tabs>
<TabItem value="ufw" label="ufw" default>
```bash
ufw allow 6380
```
</TabItem>
<TabItem value="iptables" label="iptables">
```bash
iptables -A INPUT -p tcp --dport 6380 -j ACCEPT
iptables -A OUTPUT -p tcp --dport 6380 -j ACCEPT
```
</TabItem>
</Tabs>