mirror of https://github.com/thomiceli/opengist.git synced 2024-12-22 20:42:40 +00:00

Self-hosted pastebin powered by Git, open-source alternative to Github Gist.

docker gist git go golang pastebin pastebin-service self-hosted tailwindcss typescript

Find a file

Thomas Miceli 7fc8577ce0 Translated using Weblate (French) (#201 ) Currently translated at 100.0% (180 of 180 strings) Translation: Opengist/Opengist Translate-URL: http://tr.opengist.io/projects/_/opengist/fr/		2024-01-06 14:35:08 +01:00
.github	Ignore .yml files for Github Actions	2024-01-05 04:36:05 +01:00
docker	config.yml with Docker (#131 )	2023-10-15 08:14:34 +02:00
docs	v1.6.0	2024-01-04 18:06:19 +01:00
internal	Translated using Weblate (French) (#201 )	2024-01-06 14:35:08 +01:00
public	Small fixes (#196 )	2024-01-04 18:06:19 +01:00
scripts	Add binaries cross compile in CD (#113 )	2023-09-26 15:13:58 +02:00
templates	v1.6.0	2024-01-04 18:06:19 +01:00
.dockerignore	Better build/watch	2023-04-06 13:55:04 +02:00
.gitattributes	Tweaked project structure (#88 )	2023-09-03 00:30:57 +02:00
.gitignore	Add binaries cross compile in CD (#113 )	2023-09-26 15:13:58 +02:00
CHANGELOG.md	v1.6.0	2024-01-04 18:06:19 +01:00
config.yml	Add some docs (#198 )	2024-01-04 18:06:19 +01:00
Dockerfile	Add Healthcheck on Docker (#204 )	2024-01-06 14:35:08 +01:00
go.mod	Update dependencies (#197 )	2024-01-04 18:06:19 +01:00
go.sum	Update dependencies (#197 )	2024-01-04 18:06:19 +01:00
LICENSE	Initial commit	2023-03-14 16:22:52 +01:00
Makefile	Small fixes (#196 )	2024-01-04 18:06:19 +01:00
opengist.go	Add Gist code search (#194 )	2024-01-04 18:06:19 +01:00
package-lock.json	Update dependencies (#197 )	2024-01-04 18:06:19 +01:00
package.json	Small fixes (#196 )	2024-01-04 18:06:19 +01:00
README.md	v1.6.0	2024-01-04 18:06:19 +01:00

README.md

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.

Documentation • Demo

Features

Create public, unlisted or private snippets
Init / Clone / Pull / Push snippets via Git over HTTP or SSH
Syntax highlighting ; markdown & CSV support
Search code in snippets ; browse users snippets, likes and forks
Embed snippets in other websites
Revisions history
Like / Fork snippets
Download raw files or as a ZIP archive
OAuth2 login with GitHub, GitLab, 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.yml file 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.6.0/opengist1.6.0-linux-amd64.tar.gz

tar xzvf opengist1.6.0-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.21+), 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.