2023-04-10 22:52:52 +02:00
|
|
|
# Opengist
|
|
|
|
|
2023-09-25 18:57:47 +02:00
|
|
|
<img height="108px" src="https://raw.githubusercontent.com/thomiceli/opengist/a9dd531f676d01b93bb6bd70751a69382ca563b0/public/opengist.svg" alt="Opengist" align="right" />
|
|
|
|
|
|
|
|
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) • [Demo](https://opengist.thomice.li)
|
|
|
|
|
|
|
|
|
2023-04-10 22:52:52 +02:00
|
|
|
![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)
|
2023-09-25 18:57:47 +02:00
|
|
|
[![Go CI](https://github.com/thomiceli/opengist/actions/workflows/go.yml/badge.svg)](https://github.com/thomiceli/opengist/actions/workflows/go.yml)
|
2023-05-27 20:20:20 +02:00
|
|
|
[![Go Report Card](https://goreportcard.com/badge/github.com/thomiceli/opengist)](https://goreportcard.com/report/github.com/thomiceli/opengist)
|
2023-04-10 22:52:52 +02:00
|
|
|
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
2023-09-02 03:58:37 +02:00
|
|
|
* Create public, unlisted or private snippets
|
2023-09-25 18:57:47 +02:00
|
|
|
* [Init](/docs/usage/init-via-git.md) / Clone / Pull / Push snippets **via Git** over HTTP or SSH
|
2023-04-10 22:52:52 +02:00
|
|
|
* Revisions history
|
|
|
|
* Syntax highlighting ; markdown & CSV support
|
|
|
|
* Like / Fork snippets
|
2023-06-23 14:25:03 +02:00
|
|
|
* Search for snippets ; browse users snippets, likes and forks
|
2023-04-10 22:52:52 +02:00
|
|
|
* Download raw files or as a ZIP archive
|
2023-09-15 23:56:14 +02:00
|
|
|
* OAuth2 login with GitHub, Gitea, and OpenID Connect
|
2023-04-28 20:31:10 +02:00
|
|
|
* Restrict or unrestrict snippets visibility to anonymous users
|
2023-04-10 22:52:52 +02:00
|
|
|
* Docker support
|
2023-09-25 18:57:47 +02:00
|
|
|
* [More...](/docs/index.md#features)
|
2023-04-10 22:52:52 +02:00
|
|
|
|
2023-09-25 18:57:47 +02:00
|
|
|
## Quick start
|
2023-04-10 22:52:52 +02:00
|
|
|
|
|
|
|
### With Docker
|
|
|
|
|
2023-07-17 04:16:08 +02:00
|
|
|
Docker [images](https://github.com/thomiceli/opengist/pkgs/container/opengist) are available for each release :
|
2023-04-10 22:52:52 +02:00
|
|
|
|
2023-06-07 20:50:30 +02:00
|
|
|
```shell
|
2023-09-25 18:57:47 +02:00
|
|
|
docker pull ghcr.io/thomiceli/opengist:1
|
2023-04-10 22:52:52 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
It can be used in a `docker-compose.yml` file :
|
|
|
|
|
|
|
|
1. Create a `docker-compose.yml` file with the following content
|
2023-04-12 12:50:47 +02:00
|
|
|
2. Run `docker compose up -d`
|
2023-04-10 22:52:52 +02:00
|
|
|
3. Opengist is now running on port 6157, you can browse http://localhost:6157
|
|
|
|
|
|
|
|
```yml
|
|
|
|
version: "3"
|
|
|
|
|
|
|
|
services:
|
|
|
|
opengist:
|
2023-06-23 14:25:03 +02:00
|
|
|
image: ghcr.io/thomiceli/opengist:1.4
|
2023-04-10 22:52:52 +02:00
|
|
|
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:
|
2023-06-18 12:50:36 +02:00
|
|
|
- "$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
|
2023-04-10 22:52:52 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
### From source
|
|
|
|
|
2023-09-18 18:17:11 +02:00
|
|
|
Requirements : [Git](https://git-scm.com/downloads) (2.20+), [Go](https://go.dev/doc/install) (1.20+), [Node.js](https://nodejs.org/en/download/) (16+)
|
2023-04-10 22:52:52 +02:00
|
|
|
|
|
|
|
```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
|
|
|
|
|
2023-04-17 21:57:03 +02:00
|
|
|
|
2023-09-25 18:57:47 +02:00
|
|
|
## Documentation
|
2023-04-17 21:57:03 +02:00
|
|
|
|
2023-09-25 18:57:47 +02:00
|
|
|
The documentation is available in [/docs](/docs) directory.
|
2023-09-15 23:56:14 +02:00
|
|
|
|
|
|
|
|
2023-04-10 22:52:52 +02:00
|
|
|
## License
|
|
|
|
|
2023-09-25 18:57:47 +02:00
|
|
|
Opengist is licensed under the [AGPL-3.0 license](/LICENSE).
|