mirror of
https://github.com/thomiceli/opengist.git
synced 2024-12-23 04:52:40 +00:00
113 lines
3.8 KiB
Markdown
113 lines
3.8 KiB
Markdown
# Opengist
|
|
|
|
<img height="108px" src="https://raw.githubusercontent.com/thomiceli/opengist/master/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 similar to [GitHub Gist](https://gist.github.com/), but open-source and could be self-hosted.
|
|
|
|
[Home Page](https://opengist.io) • [Documentation](https://opengist.io/docs) • [Discord](https://discord.gg/9Pm3X5scZT) • [Demo](https://demo.opengist.io)
|
|
|
|
|
|
|
|
|
|
[](https://github.com/thomiceli/opengist/actions/workflows/go.yml)
|
|
[](https://goreportcard.com/report/github.com/thomiceli/opengist)
|
|
[](https://tr.opengist.io/projects/_/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/introduction.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.8
|
|
```
|
|
|
|
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
|
|
services:
|
|
opengist:
|
|
image: ghcr.io/thomiceli/opengist:1.8
|
|
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.8.1/opengist1.8.1-linux-amd64.tar.gz
|
|
|
|
tar xzvf opengist1.8.1-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.23+), [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/development.md).
|
|
|
|
## Documentation
|
|
|
|
The documentation is available at [https://opengist.io/](https://opengist.io/) or in the [/docs](/docs) directory.
|
|
|
|
|
|
## License
|
|
|
|
Opengist is licensed under the [AGPL-3.0 license](/LICENSE).
|