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: 26 days ago
JSON representation
Self-hosted pastebin powered by Git, open-source alternative to Github Gist.
- Host: GitHub
- URL: https://github.com/thomiceli/opengist
- Owner: thomiceli
- License: agpl-3.0
- Created: 2023-04-10T20:58:35.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-02T01:13:23.000Z (about 1 month ago)
- Last Synced: 2024-10-02T01:42:33.376Z (about 1 month ago)
- Topics: docker, gist, git, go, golang, pastebin, pastebin-service, self-hosted, tailwindcss, typescript
- Language: Go
- Homepage: https://opengist.io
- Size: 2.06 MB
- Stars: 1,694
- Watchers: 8
- Forks: 90
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing/community.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - thomiceli/opengist - Self-hosted pastebin powered by Git, open-source alternative to Github Gist. (Go)
- my-awesome - thomiceli/opengist - service,self-hosted,tailwindcss,typescript pushed_at:2024-10 star:1.8k fork:0.1k Self-hosted pastebin powered by Git, open-source alternative to Github Gist. (Go)
README
# 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.
[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)
## 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.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
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.5/opengist1.7.5-linux-amd64.tar.gz
tar xzvf opengist1.7.5-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/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).