Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/thomiceli/opengist

Self-hosted pastebin powered by Git, open-source alternative to Github Gist.
https://github.com/thomiceli/opengist

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

Last synced: 23 days ago
JSON representation

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

Lists

README 

        
# Opengist



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](https://gist.github.com/), but open-source and could be self-hosted.



[Documentation](/docs) • [Discord](https://discord.gg/9Pm3X5scZT) • [Demo](https://demo.opengist.io)



![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/thomiceli/opengist?sort=semver)

![License](https://img.shields.io/github/license/thomiceli/opengist?color=blue)

[![Go CI](https://github.com/thomiceli/opengist/actions/workflows/go.yml/badge.svg)](https://github.com/thomiceli/opengist/actions/workflows/go.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/thomiceli/opengist)](https://goreportcard.com/report/github.com/thomiceli/opengist)



## Features



* Create public, unlisted or private snippets

* [Init](/docs/usage/init-via-git.md) / 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...](/docs/index.md#features)



## Quick start



### With Docker



Docker [images](https://github.com/thomiceli/opengist/pkgs/container/opengist) are available for each release :



```shell

docker pull ghcr.io/thomiceli/opengist:1.7

```



It can be used in a `docker-compose.yml` file :



1. Create a `docker-compose.yml` file with the following content

2. Run `docker compose up -d`

3. Opengist is now running on port 6157, you can browse http://localhost:6157



```yml

version: "3"



services:

  opengist:

    image: ghcr.io/thomiceli/opengist:1.7

    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 :



```yml

services:

  opengist:

    # ...

    environment:

      UID: 1001

      GID: 1001

```



### Via binary



Download the archive for your system from the release page [here](https://github.com/thomiceli/opengist/releases/latest), and extract it.



```shell

# example for linux amd64

wget https://github.com/thomiceli/opengist/releases/download/v1.7.2/opengist1.7.2-linux-amd64.tar.gz



tar xzvf opengist1.7.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](https://git-scm.com/downloads) (2.28+), [Go](https://go.dev/doc/install) (1.22+), [Node.js](https://nodejs.org/en/download/) (16+), [Make](https://linux.die.net/man/1/make) (optional, but easier)



```shell

git clone https://github.com/thomiceli/opengist

cd opengist

make

./opengist

```



Opengist is now running on port 6157, you can browse http://localhost:6157



---



To create and run a development environment, see [run-development.md](/docs/contributing/run-development.md).



## Documentation



The documentation is available in [/docs](/docs) directory.



## License



Opengist is licensed under the [AGPL-3.0 license](/LICENSE).