|
|
||
|---|---|---|
| .github/workflows | ||
| docker | ||
| docs | ||
| internal | ||
| public | ||
| scripts | ||
| templates | ||
| .dockerignore | ||
| .gitattributes | ||
| .gitignore | ||
| CHANGELOG.md | ||
| config.yml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| opengist.go | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.js | ||
| README.md | ||
| tailwind-embed.config.js | ||
| tailwind.config.js | ||
| tsconfig.json | ||
| vite.config.js | ||
Opengist
Opengist is a self-hosted pastebin powered by Git. All snippets are stored in a Git repository and can be read and/or modified using standard Git commands, or with the web interface. It is similiar to GitHub Gist, but open-source and could be self-hosted.
Features
- Create public, unlisted or private snippets
- Init / Clone / Pull / Push snippets via Git over HTTP or SSH
- Revisions history
- Syntax highlighting ; markdown & CSV support
- Like / Fork snippets
- Search for snippets ; browse users snippets, likes and forks
- Download raw files or as a ZIP archive
- OAuth2 login with GitHub, Gitea, and OpenID Connect
- Restrict or unrestrict snippets visibility to anonymous users
- Docker support
- More...
Quick start
With Docker
Docker images are available for each release :
docker pull ghcr.io/thomiceli/opengist:1
It can be used in a docker-compose.yml file :
- Create a
docker-compose.ymlfile with the following content - Run
docker compose up -d - Opengist is now running on port 6157, you can browse http://localhost:6157
version: "3"
services:
opengist:
image: ghcr.io/thomiceli/opengist:1
container_name: opengist
restart: unless-stopped
ports:
- "6157:6157" # HTTP port
- "2222:2222" # SSH port, can be removed if you don't use SSH
volumes:
- "$HOME/.opengist:/opengist"
You can define which user/group should run the container and own the files by setting the UID and GID environment variables :
services:
opengist:
# ...
environment:
UID: 1001
GID: 1001
Via binary
Download the archive for your system from the release page here, and extract it.
# example for linux amd64
wget https://github.com/thomiceli/opengist/releases/download/v1.5.2/opengist1.5.2-linux-amd64.tar.gz
tar xzvf opengist1.5.2-linux-amd64.tar.gz
cd opengist
chmod +x opengist
./opengist # with or without `--config config.yml`
Opengist is now running on port 6157, you can browse http://localhost:6157
From source
Requirements : Git (2.28+), Go (1.20+), Node.js (16+)
git clone https://github.com/thomiceli/opengist
cd opengist
make
./opengist
Opengist is now running on port 6157, you can browse http://localhost:6157
Documentation
The documentation is available in /docs directory.
License
Opengist is licensed under the AGPL-3.0 license.