Skip to content

Repository files navigation

Forgejo

Build Status Last Commit

Forgejo is a self-hosted lightweight software forge

Port 3000
Registry ghcr.io/daemonless/forgejo
Source https://codeberg.org/forgejo/forgejo
Website https://forgejo.org/

Version Tags

Tag Description Best For
15 / lts Built from latest upstream source release of the v15 branch. Alternative build.
15-latest / lts-latest Built from latest upstream source release of the v15 branch with latest FreeBSD packages. Most users — recommended.
15-pkg-latest / lts-pkg-latest FreeBSD Latest. Rolling package updates. Staying current.
16 Built from latest upstream source release of the v16 branch. Alternative build.
16-latest Built from latest upstream source release of the v16 branch with latest FreeBSD packages. Alternative build.
16-pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  forgejo:
    image: "ghcr.io/daemonless/forgejo:latest"
    container_name: forgejo
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - SSH_PORT=2222  # Published port for sshd (used in clone URLs)
      - SSH_LISTEN_PORT=22  # Port on which sshd listens inside the container
    volumes:
      - "/path/to/containers/forgejo:/config"
    ports:
      - "3000:3000"
      - "2222:22"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=forgejo
PUID=1000
PGID=1000
TZ=UTC
SSH_PORT=2222
SSH_LISTEN_PORT=22

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  forgejo:
    name: forgejo
    options:
      - container: 'boot args:--pull'
      - expose: '3000:3000 proto:tcp'
      - expose: '2222:22 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - SSH_PORT: !ENV '${SSH_PORT}'
        - SSH_LISTEN_PORT: !ENV '${SSH_LISTEN_PORT}'
    volumes:
      - forgejo: /config
volumes:
  forgejo:
    device: '/path/to/containers/forgejo'

Makejail:

# Makejail

ARG tag=15

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/forgejo:${tag}

Save the files above, then run appjail-director up.

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Podman CLI

podman run -d --name forgejo \
  -p 3000:3000 \
  -p 2222:22 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e SSH_PORT=2222 \
  -e SSH_LISTEN_PORT=22 \
  -v /path/to/containers/forgejo:/config \
  ghcr.io/daemonless/forgejo:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="3000:3000 proto:tcp" \
  -o expose="2222:22 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e SSH_PORT=2222 \
  -e SSH_LISTEN_PORT=22 \
  -o fstab="/path/to/containers/forgejo /config <pseudofs>" \
  ghcr.io/daemonless/forgejo:latest forgejo

Save as run.sh, then run sh run.sh.

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah, shares the host network stack (inherit), and persists image-declared volumes under --data-path.

services:
  forgejo:
    image: "ghcr.io/daemonless/forgejo:latest"
    container_name: forgejo
    network_mode: host  # jail shares host networking
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
      - SSH_PORT=2222
      - SSH_LISTEN_PORT=22

Save as podman-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --env SSH_PORT=2222 \
  --env SSH_LISTEN_PORT=22 \
  --data-path /path/to/containers/forgejo \
  forgejo ghcr.io/daemonless/forgejo:latest inherit

Ansible

- name: Deploy forgejo
  containers.podman.podman_container:
    name: forgejo
    image: "ghcr.io/daemonless/forgejo:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
      SSH_PORT: "2222"
      SSH_LISTEN_PORT: "22"
    ports:
      - "3000:3000"
      - "2222:22"
    volumes:
      - "/path/to/containers/forgejo:/config"

Save as forgejo-deploy.yaml, then run ansible-playbook forgejo-deploy.yaml.

Access at: http://localhost:3000

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
SSH_PORT 2222 Published port for sshd (used in clone URLs)
SSH_LISTEN_PORT 22 Port on which sshd listens inside the container

Volumes

Path Description
/config Configuration, repositories, and data directory

Ports

Port Protocol Description
3000 TCP Web UI
22 TCP SSH port

First run

If no configuration file exists when the container starts, it will generate an initial default config file at /config/custom/conf/app.ini. You can make configuration changes in this file later (e.g. SMTP configuration) and they will be preserved across container restarts.

SSH Setup

If you modify the port mapping from the default 2222:22 you need to update the 2 environment variables described below accordingly.

SSH_LISTEN_PORT env var

This variable indicates on which port Forgejo's ssh server listens inside the container. If your port mapping for ssh is 2222:22, this variable should be set to 22. This variable is used on every container start to modify the sshd_config config file.

SSH_PORT env var

This variable tells Forgejo on which port the ssh server is reachable from the outside and is used when constructing the ssh URLs shown in Forgejo's web UI. If your port mapping for ssh is 2222:22, this variable should be set to 2222. This variable is used only during the first container startup to create the initial configuration file for Forgejo. If you want to modify the SSH_PORT later, you need to change the configuration in the [server] section of /config/custom/conf/app.ini.

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

Releases

Packages

Contributors

Languages