38 lines
No EOL
2 KiB
Markdown
38 lines
No EOL
2 KiB
Markdown
# cloudflare-tunnels-plugin
|
|
|
|
Minecraft plugin to spawn a remotley managed cloudflared instance on your server.
|
|
|
|
## Development
|
|
|
|
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/`).
|
|
|
|
## 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. **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 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
|
|
|
|
Unless otherwise stated, all files in this repository are free software, licensed under the Apache License 2.0. See the `LICENSE` file for more information. |