A pastebin designed for easy self-hosting and personal use.
Download a Linux binary from here. After extraction, configure gluecan-config.yml and run bin/gluecan. Requires Java >= 8.
Docker images are published at kesslern/gluecan. To use the docker image:
- Make your copy of
gluecan-config.ymlavailable on a volume - Set the environment variable
GLUECAN_CONFIG_PATHto the full path of the configuration file - In the configuration file, be sure the database path points to an external volume. If not, the database will be erased when the docker updates.
For example: docker run -v /directory/with/config/file/:/config -e GLUECAN_CONFIG_PATH=/config/gluecan-config.yml -p 8080:8080 kesslern/gluecan:latest
To build a production-ready distributable, run ./gradlew distZip. A distributable will be at gluecan-backend/build/distributions/gluecan.zip. Extract and run the appropriate script from the bin folder. Requires Java >= 8.
GlueCan's pastes are always publicly viewable, but creation and deletion of pastes can be restricted by enabling private mode. When private mode is enabled, a password is required to access the administration UI and delete or create new pastes.
By default, gluecan-config.yml is loaded from the current working directory. If the environment variable GLUECAN_CONFIG_PATH is defined, that value is used instead.
There is an example in the repository.
| Configuration Key | Description |
|---|---|
| port | The port to listen on. |
| sslPort | The port to listen on for SSL, if used. |
| public | If true, GlueCan is public and anyone can create or delete pastes. |
| admin_pass | THE password if running in private mode. Unused in public mode. |
| database | Database path/filename to use. |
| keystore.path | If defined, GlueCan will use the provided keystore to create a secure SSL connection. |
| keystore.password | The keystore password to use. |
GlueCan uses clipboard APIs which are only available when running in a sceure context (HTTPS or localhost). Outside of a secure context, some GlueCan functionality will not work, and there is no graceful fallback.
- JDK 8+
- Node 10+
- Yarn (latest version)
The backend can be started with ./gradlew run. The configuration file at gluecan-backend/gluecan-config.yml will be used. Frontend resources will be included, but not updated unless the backend is restarted.
./gradlew run will create a production build from gluecan-frontend and serve the files from the classpath. The backend will have to be restarted for UI changes to take effect. For faster frontend development, the yarn development server should be used to provide better debugging, error reporting, and hot module reloading.
Change the working directory gluecan-frontend and run yarn start to start the development server at localhost:3000. API requests will be proxied to the backend service at localhost:8080. When running the development server, changes made the UI will be reflected immediately, without requiring the backend service to restart.
Production releases are produced using the Gradle Application Plugin. Running ./gradlew distZip will run yarn build in the frontend module to produce production-ready frontend resources and bundle them in the classpath when producing the backend module. The entire application will be bundled into gluecan-backend/build/distributions/gluecan.zip and can be ran from the included shell and batch scripts.
- Javalin
- Gradle
- Kotlin
- Material UI
- Jetty
- create-react-app
- redux-starter-kit
- react-router
- highlight.js
This project is licensed under the ISC License - see LICENSE.md.