ivycollective/cloudflare-tunnels-plugin
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Packages Wiki Activity Actions

update README.md

Browse source
This commit is contained in:
Ivy Collective 2025-01-11 23:52:31 -05:00
parent 07983331d6
commit a7f6a99489
1 changed files with 18 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -2,28 +2,37 @@
Minecraft plugin to spawn a remotley managed cloudflared instance on your server.
Hasn't been well tested; use at your own risk.
## Development
## Setup
This plugin uses Paper (version 1.21) and Gradle. If you would like to build the plugin, run `./gradlew build` for a binary (in `build/libs/`).
* Install the plugin onto a paper server. Start the server to generate the config file, and stop it.
* Change all the values in the `plugins/cloudflare-tunnels-plugin/config.yml` to desired values.
* Set `installed: true`.
* Restart your server.
* Enjoy! :3
## Installation
Releases are available at https://git.ivycollective.dev/ivycollective/cloudflare-tunnels-plugin/releases.
Installation instructions:
1. Install the plugin onto a paper server. Start the server to generate the config file, and stop it.
2. Change all the values in the `plugins/cloudflare-tunnels-plugin/config.yml` to desired values. (see configuration section below)
3. Set `installed: true`.
4. Restart your server.
5. Enjoy! :3
## Configuration
* `download.url`: link to a binary. use the VERSION placeholder to use the version in the `download.variable` property.
* `download.url`: link to a binary. use the `VERSION` placeholder to use the version in the `download.variable` property. **Always change if you are not using Linux amd64.** See https://github.com/cloudflare/cloudflared/releases for some valid file names.
* `download.version`: version of cloudflared to download. defaults to the latest version.
* `token`: your cloudflared token. see https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/get-started/create-remote-tunnel/
* `notify-ops-on-exit`: notify server operators when cloudflared exists for whatever reason.
* `notify-ops-on-exit`: notify server operators when cloudflared exists for any reason, and if it is being restarted.
* `log-level`: cloudflared log level. defaults to `info`.
* `disable-tls`: do not check for valid SSL certificates when using cloudflared.
* `restart.auto-restart`: automatically restart cloudflared if it exits.
* `restart.interval-seconds`: time, in seconds, to wait between automatic restarts.
* `installed`: set to `true` when the plugin is fully configured (the properties above are all set).
## Contact
If you need to contact us for any reason, including bug reports, feature requests, patches, or help with the plugin, send an email to us at `sys@ivycollective.dev`.
## License
This software is free software, under the Apache License 2.0. Read the `LICENSE` file for more information.