v1.6.0

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: thomiceli

.github/workflows/go.yml

@@ -13,10 +13,10 @@ jobs:
  - name: Checkout
  uses: actions/checkout@v3
 
- - name: Set up Go 1.20
+ - name: Set up Go 1.21
  uses: actions/setup-go@v4
  with:
- go-version: "1.20"
+ go-version: "1.21"
 
  - name: Lint
  uses: golangci/golangci-lint-action@v3
@@ -34,10 +34,10 @@ jobs:
  - name: Checkout
  uses: actions/checkout@v3
 
- - name: Set up Go 1.20
+ - name: Set up Go 1.21
  uses: actions/setup-go@v4
  with:
- go-version: "1.20"
+ go-version: "1.21"
 
  - name: Check
  run: make go_mod check_changes
@@ -47,7 +47,7 @@ jobs:
  fail-fast: false
  matrix:
  os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
- go: ["1.20", "1.21"]
+ go: ["1.21"]
  runs-on: ${{ matrix.os }}
  steps:
  - name: Checkout

.github/workflows/release.yml

@@ -13,10 +13,10 @@ jobs:
  - name: Checkout
  uses: actions/checkout@v3
 
- - name: Set up Go 1.20
+ - name: Set up Go 1.21
  uses: actions/setup-go@v4
  with:
- go-version: "1.20"
+ go-version: "1.21"
 
  - name: Cross compile build
  run: make all_crosscompile

CHANGELOG.md

@@ -1,5 +1,51 @@
 # Changelog
 
+## [1.6.0](https://github.com/thomiceli/opengist/compare/v1.5.3...v1.6.0) - 2024-01-04
+See here how to [update](/docs/update.md) Opengist.
+
+### Added
+- Embedded gists (#179)
+- Gist code search (#194)
+- Custom URLS for gists (#183)
+- Gist JSON data/metadata (#179)
+- Keep default visibility when creating a gist on the UI (#155)
+- Health check endpoint (#170)
+- GitLab OAuth2 login (#174)
+- Syntax highlighting for more file types (#176) 
+- Checkable Markdown checkboxes (#182)
+- Config:
+ - Log output (#172) 
+ - Default git branch name (#171)
+- Change username setting (#190)
+- Admin actions:
+ - Synchronize all gists previews (#191)
+ - Reset Git server hooks for all repositories (#191)
+ - Index all gists (#194)
+- Translations:
+ - cs-CZ (#164)
+ - zh-TW (#166, #195)
+ - hu-HU (#185)
+ - pt-BR (#193)
+- Docs (#198)
+
+### Changed
+- Updated dependencies (#197):
+ - Go `1.20` -> `1.21` 
+ - JavaScript packages
+ - NodeJS Docker image `18` -> `20`
+ - Alpine Docker image `3.17` -> `3.19`
+
+### Fixed
+- Fix reverse proxy subpath support (#192)
+- Fix undecoded gist content when going back to editing in the UI (#184)
+- Fix outputting non-truncated large files for editon/zip download (#184)
+- Allow dashes in usernames (#184)
+- Delete SSH keys associated to deleted user (#184)
+- Better error message when there is no files in gist (#184)
+- Show if there is no files in gist preview (#184)
+- Log parsing for the 11th empty commit (#184)
+- Optimize reading gist files content (#186)
+
 ## [1.5.3](https://github.com/thomiceli/opengist/compare/v1.5.2...v1.5.3) - 2023-11-20
 ### Added
 - es-ES translation (#139)

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.17 AS build
+FROM alpine:3.19 AS build
 
 RUN apk update && \
  apk add --no-cache \
@@ -7,10 +7,10 @@ RUN apk update && \
  musl-dev \
  libstdc++
 
-COPY --from=golang:1.20-alpine /usr/local/go/ /usr/local/go/
+COPY --from=golang:1.21-alpine /usr/local/go/ /usr/local/go/
 ENV PATH="/usr/local/go/bin:${PATH}"
 
-COPY --from=node:18-alpine /usr/local/ /usr/local/
+COPY --from=node:20-alpine /usr/local/ /usr/local/
 ENV NODE_PATH="/usr/local/lib/node_modules"
 ENV PATH="/usr/local/bin:${PATH}"
 
@@ -21,7 +21,7 @@ COPY . .
 RUN make
 
 
-FROM alpine:3.17 as run
+FROM alpine:3.19 as run
 
 RUN apk update && \
  apk add --no-cache \

Makefile

@@ -15,7 +15,8 @@ install:
 
 build_frontend:
  @echo "Building frontend assets..."
- npx vite build
+ npx vite -c public/vite.config.js build
+ @EMBED=1 npx postcss 'public/assets/embed-*.css' -c public/postcss.config.js --replace # until we can .nest { @tailwind } in Sass
 
 build_backend:
  @echo "Building Opengist binary..."
@@ -32,7 +33,7 @@ build_docker:
 
 watch_frontend:
  @echo "Building frontend assets..."
- npx vite dev --port 16157
+ npx vite -c public/vite.config.js dev --port 16157
 
 watch_backend:
  @echo "Building Opengist binary..."

README.md

@@ -19,12 +19,13 @@ It is similiar to [GitHub Gist](https://gist.github.com/), but open-source and c
 
 * Create public, unlisted or private snippets
 * [Init](/docs/usage/init-via-git.md) / Clone / Pull / Push snippets **via Git** over HTTP or SSH
-* Revisions history
 * 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
-* Search for snippets ; browse users snippets, likes and forks
 * Download raw files or as a ZIP archive
-* OAuth2 login with GitHub, Gitea, and OpenID Connect
+* OAuth2 login with GitHub, GitLab, Gitea, and OpenID Connect
 * Restrict or unrestrict snippets visibility to anonymous users
 * Docker support
 * [More...](/docs/index.md#features)
@@ -77,9 +78,9 @@ Download the archive for your system from the release page [here](https://github
 
 ```shell
 # example for linux amd64
-wget https://github.com/thomiceli/opengist/releases/download/v1.5.2/opengist1.5.2-linux-amd64.tar.gz
+wget https://github.com/thomiceli/opengist/releases/download/v1.6.0/opengist1.6.0-linux-amd64.tar.gz
 
-tar xzvf opengist1.5.2-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`
@@ -89,7 +90,7 @@ Opengist is now running on port 6157, you can browse http://localhost:6157
 
 ### From source
 
-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+)
+Requirements : [Git](https://git-scm.com/downloads) (2.28+), [Go](https://go.dev/doc/install) (1.21+), [Node.js](https://nodejs.org/en/download/) (16+)
 
 ```shell
 git clone https://github.com/thomiceli/opengist

config.yml

@@ -5,8 +5,10 @@
 # Set the log level to one of the following: trace, debug, info, warn, error, fatal, panic. Default: warn
 log-level: warn
 
-# Public URL for the Git HTTP/SSH connection.
-# If not set, uses the URL from the request
+# Set the log output to one or more of the following: `stdout`, `file`. Default: stdout,file
+log-output: stdout,file
+
+# Public URL to access to Opengist
 external-url:
 
 # Directory where Opengist will store its data. Default: ~/.opengist/
@@ -15,6 +17,16 @@ opengist-home:
 # Name of the SQLite database file. Default: opengist.db
 db-filename: opengist.db
 
+# Enable or disable the code search index (either `true` or `false`). Default: true
+index.enabled: true
+
+# Name of the directory where the code search index is stored. Default: opengist.index
+index.dirname: opengist.index
+
+# Default branch name used by Opengist when initializing Git repositories.
+# If not set, uses the Git default branch name. See https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_new_default_branch
+git.default-branch:
+
 # Set the journal mode for SQLite. Default: WAL
 # See https://www.sqlite.org/pragma.html#pragma_journal_mode
 sqlite.journal-mode: WAL
@@ -55,12 +67,18 @@ ssh.keygen-executable: ssh-keygen
 
 
 # OAuth2 configuration
-# The callback/redirect URL must be http://opengist.domain/oauth/<github|gitea|openid-connect>/callback
+# The callback/redirect URL must be http://opengist.url/oauth/<github|gitlab|gitea|openid-connect>/callback
 
 # To create a new OAuth2 application using GitHub : https://github.com/settings/applications/new
 github.client-key:
 github.secret:
 
+# To create a new OAuth2 application using Gitlab : https://gitlab.com/-/user_settings/applications
+gitlab.client-key:
+gitlab.secret:
+# URL of the Gitlab instance. Default: https://gitlab.com/
+gitlab.url: https://gitlab.com/
+
 # To create a new OAuth2 application using Gitea : https://gitea.domain/user/settings/applications
 gitea.client-key:
 gitea.secret:

docs/administration/healthcheck.md

@@ -0,0 +1,13 @@
+# Healthcheck
+
+A healthcheck is a simple HTTP GET request to the `/healthcheck` endpoint. It returns a `200 OK` response if the server is healthy.
+
+## Example
+
+```shell
+curl http://localhost:6157/healthcheck
+```
+
+```json
+{"database":"ok","opengist":"ok","time":"2024-01-04T05:18:33+01:00"}
+```

docs/administration/nginx-reverse-proxy.md

@@ -1,6 +1,10 @@
 # Use Nginx as a reverse proxy
 
-Configure Nginx to proxy requests to Opengist. Here is an example configuration file :
+Configure Nginx to proxy requests to Opengist. Here are example configuration file to use Opengist on a subdomain or on a subpath.
+
+Make sure you set the base url for Opengist via the [configuration](/docs/configuration/cheat-sheet.md).
+
+### Subdomain
 ```
 server {
  listen 80;
@@ -16,7 +20,27 @@ server {
 }
 ```
 
-Then run :
+### Subpath
+```
+server {
+ listen 80;
+ server_name example.com;
+
+ location /opengist/ {
+ rewrite ^/opengist(/.*)$ $1 break;
+ proxy_pass http://127.0.0.1:6157;
+ proxy_set_header Host $host;
+ proxy_set_header X-Real-IP $remote_addr;
+ proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-Proto $scheme;
+ proxy_set_header X-Forwarded-Prefix /opengist;
+ }
+}
+```
+
+---
+
+To apply changes:
 ```shell
-service nginx restart
+sudo systemctl restart nginx
 ```

docs/administration/oauth-providers.md

@@ -4,19 +4,32 @@ Opengist can be configured to use OAuth to authenticate users, with GitHub, Gite
 
 ## Github
 
-* Add a new OAuth app in your [Github account settings](https://github.com/settings/applications/new)
-* Set 'Authorization callback URL' to `http://opengist.domain/oauth/github/callback`
+* Add a new OAuth app in your [GitHub account settings](https://github.com/settings/applications/new)
+* Set 'Authorization callback URL' to `http://opengist.url/oauth/github/callback`
 * Copy the 'Client ID' and 'Client Secret' and add them to the [configuration](/docs/configuration/cheat-sheet.md) :
  ```yaml
  github.client-key: <key>
  github.secret: <secret>
  ```
 
 
+## GitLab
+
+* Add a new OAuth app in Application settings from the [GitLab instance](https://gitlab.com/-/user_settings/applications)
+* Set 'Redirect URI' to `http://opengist.url/oauth/gitlab/callback`
+* Copy the 'Client ID' and 'Client Secret' and add them to the [configuration](/docs/configuration/cheat-sheet.md) :
+ ```yaml
+ gitlab.client-key: <key>
+ gitlab.secret: <secret>
+ # URL of the GitLab instance. Default: https://gitlab.com/
+ gitlab.url: https://gitlab.com/
+ ```
+
+
 ## Gitea
 
 * Add a new OAuth app in Application settings from the [Gitea instance](https://gitea.com/user/settings/applications)
-* Set 'Redirect URI' to `http://opengist.domain/oauth/gitea/callback`
+* Set 'Redirect URI' to `http://opengist.url/oauth/gitea/callback`
 * Copy the 'Client ID' and 'Client Secret' and add them to the [configuration](/docs/configuration/cheat-sheet.md) :
  ```yaml
  gitea.client-key: <key>
@@ -29,7 +42,7 @@ Opengist can be configured to use OAuth to authenticate users, with GitHub, Gite
 ## OpenID Connect
 
 * Add a new OAuth app in Application settings of your OIDC provider
-* Set 'Redirect URI' to `http://opengist.domain/oauth/openid-connect/callback`
+* Set 'Redirect URI' to `http://opengist.url/oauth/openid-connect/callback`
 * Copy the 'Client ID', 'Client Secret', and the discovery endpoint, and add them to the [configuration](/docs/configuration/cheat-sheet.md) :
  ```yaml
  oidc.client-key: <key>