GitPlug icon

GitPlug -----

The easiest way to edit your server files



Description:
This plugin allows server owners and admins to upload their server files to a GitHub repository. Through this, owners and admins can then use this repository to allow developers and lower staff to manage server files while allowing for review and controlled implementation on live servers. You can also easily setup test servers with the same files as the production server by using the same GitHub repository.

Features:
- Specify certain files/folders to be uploaded to the repository.
- Block certain files/folders from being uploaded that may contain sensitive information such as passwords and API keys.
- A easy to use permission system that allows only specific users to push to and pull from the repository.
- A simple and secure way of managing server files without having to give out full server access.


Commands:
- /push: Pushes the local server files to GitHub repository
- /pull: Pulls files from the GitHub repository and updates the local server files


Permissions:
- gitplug.*: A wildcard permission that gives the player/group access to all permissions.
- gitplug.push: Gives the player/group access to the /push command.
- gitplug.pull: Gives the player/group access to the /pull command.


How to setup:
Step 1: Add the plugin to your server plugins folder.
Step 2: Start up your server and wait until the server has completely started. You should receive a warning say that the personal access token is invalid.
Step 3: Create a personal access token for your GitHub account. If you don't know how to do that, follow this tutorial. The token should have ONLY the "repo" permission and the "delete_repo" permission.
Step 4: Copy that personal access token into your config.yml file.
Step 5: Change the user id field to your user id.
Step 6: Change the repo-name field to the name that you want your repository to be. Make sure there are no spaces in the repository name
Step 7: Start up the server again. It should now start up without any issues however the setup is not quite complete.

Step 8: Go into your GitHub account and go into the repository that has the same name as the value your set in the config file.
Step 9: Now, click on the highlighted text that says "README" and then scroll down and click "Commit new file".
Step 10: Next, click on the text "README.md" that is in the section as the text "Create README.md"
Step 11: Then click on the icon that looks like a garbage can and then click on "Commit Changes"

How to use:

After you setup the plugin and the GitHub repository, you should be able to use the /push command on the Minecraft server. (Note 1: You shouldn't need to restart if it is still running after following the setup tutorial) (Note 2: You may want to edit the config.yml file of this file and remove "log", "world", "world_nether", and "world_the_end" from the "files" list as they are quite large folders and will take a while to upload/download) You can then edit the files in the GitHub browser editor or download them (if you don't know how, there are many tutorials out there to follow). Once you are done editing them, you can use /pull to update your server's local files.

If you have any issues or questions, do not use the review section as support for you will receive none. Instead, add MrGeoTech#0001 on Discord and them DM me.
Resource Information
Author:
----------
Total Downloads: 45
First Release: Jul 4, 2022
Last Update: Jul 4, 2022
Category: ---------------
All-Time Rating:
0 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings