Arkanum - Code-Server container optimized for daily use.
Go to file
OCram85 04a741bcea
All checks were successful
ci/woodpecker/push/docs Pipeline was successful
ci/woodpecker/push/ci Pipeline was successful
update blog + bump golang (#108)
### 📖 Summary

- bump used golang version
- use blog section title as slot.
- remove draft post	2
- fix typo
- add faq content

### 📑 Test Plan

 CI pipeline tests (Default)

### 💬 Details

_No response_

### 📚 Additional Notes

_No response_

Reviewed-on: #108
2024-06-11 16:07:10 +02:00
.gitea updatest gitea meta files (#75) 2023-11-12 13:33:44 +01:00
.vscode add site with docs (#97) 2024-05-22 10:07:32 +02:00
.woodpecker fix typo (#104) 2024-06-03 09:55:29 +02:00
assets add site with docs (#97) 2024-05-22 10:07:32 +02:00
docs update blog + bump golang (#108) 2024-06-11 16:07:10 +02:00
FiraCode adds FiraCode NerdFont (#9) 2022-11-10 08:14:28 +01:00
.changelog.yml add site with docs (#97) 2024-05-22 10:07:32 +02:00
.dockerignore add site with docs (#97) 2024-05-22 10:07:32 +02:00
.editorconfig Initial commit 2022-09-29 15:47:57 +02:00
.gitattributes adds FiraCode NerdFont (#9) 2022-11-10 08:14:28 +01:00
.gitignore add site with docs (#97) 2024-05-22 10:07:32 +02:00
.gitlocal Initial commit 2022-09-29 15:47:57 +02:00
.prettierrc add site with docs (#97) 2024-05-22 10:07:32 +02:00
arkanum update blog + bump golang (#108) 2024-06-11 16:07:10 +02:00
arkanum-completion add bun installer (#81) 2023-12-18 18:37:26 +01:00
bun.lockb add site with docs (#97) 2024-05-22 10:07:32 +02:00
Caddyfile add site with docs (#97) 2024-05-22 10:07:32 +02:00 prep/v1.5.2 (#105) 2024-06-04 16:36:35 +02:00
Dockerfile chore(deps): update docker tag to v4.89.1 (#100) 2024-06-03 09:58:04 +02:00
Dockerfile.vitepress chore(deps): update caddy docker tag to v2.8.4 (#106) 2024-06-11 15:04:41 +02:00
gitconfig-system add system gitconfig (#4) 2022-11-08 16:06:51 +01:00
index.ts add site with docs (#97) 2024-05-22 10:07:32 +02:00
LICENSE adds AGPLv3 license (#20) 2022-11-21 20:00:59 +01:00
package.json prep/v1.5.2 (#105) 2024-06-04 16:36:35 +02:00 add site with docs (#97) 2024-05-22 10:07:32 +02:00
renovate.json fix renovate config keys (#34) 2023-01-02 13:55:15 +01:00
starship.toml disable starship python module (#52) 2023-07-19 09:34:25 +02:00
tsconfig.json add site with docs (#97) 2024-05-22 10:07:32 +02:00


🧙 Arkanum 🌌 ☄️ 💥

... is a Code-Server container optimized for daily use.

Master Branch Build Status

🤖 Quickstart

1. Get the image 📦

You can download the image from the gitea embedded container registry: with these tags:

  • latest - Is based on the lasted master branch commit.
  • next - Is a test build based on the pull request
  • 1, 0.1, 0.1.0, 1.0.0 - tag based version.

💡 NOTE: See the packages page for latest version and all other available tags.

The container images are also published to these registries:

2.a Run as Docker Swarm Stack

This example shows how to run arkanum as an additional swarm stack.

Therefore you need

  • an already running docker swarm cluster,
  • a running traefik instance handling the http and https routes,
  • configured to expose services in the a ingress overlay network called traefik-public.

Warning: Make sure to secure the access to arkanum with proper authentication method and use a trusted + secure https connection.

version: '3.8'
      - PUID=1000
      - PGID=1000
      - TZ=Europe/Berlin
      - PASSWORD=foo #optional
      #- HASHED_PASSWORD= #optional
      - SUDO_PASSWORD=foobar #optional
      #- SUDO_PASSWORD_HASH= #optional
      #- #optional
      - DEFAULT_WORKSPACE=/config/workspace
      replicas: 1
        - 'traefik.enable=true'
        - ''
        - 'traefik.http.routers.arkanum.rule=Host(``)'
        - 'traefik.http.routers.arkanum.tls.certresolver=myresolver'
        - ''
      # store workspace and use config in volume.
      - codedata:/config
      # mount docker socket to manage host docker
      - /var/run/docker.sock:/var/run/docker.sock
    # no need to expose the port. traefik acts as reverse proxy and handles the https access.
    #  - 8443:8443
      - arkanum-sphere
      - traefik-public


    external: true

💡 NOTE: For advanced config with additional environment variables see linuxserver/docker-code-server help.

2.b Use Docker-Compose

This is a basic example for a docker-compose file from the linuxserver/docker-code-server project.

See their docs about a detailed help for advanced config parameters.

version: '3.8'
    container_name: code-server
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - PASSWORD=password #optional
      - HASHED_PASSWORD= #optional
      - SUDO_PASSWORD=password #optional
      - SUDO_PASSWORD_HASH= #optional
      - #optional
      - DEFAULT_WORKSPACE=/config/workspace #optional
      - /path/to/appdata/config:/config
      - 8443:8443
    restart: unless-stopped

3. 🦶 First Steps

After summon Arkanum your first steps should be to set your username and email in the git config:

arkanum git setup "my-name" "my-email"

And that's it. Now you're ready use arkanum as your daily remote code editor. 😄

📖 Content


🚀 Starship prompt

We added the Starship prompt is as default in the integrated terminal. The default config uses Emojis and FiraCode icons.

🔱 git config

Added default git system config file with:

  • code-server as default editor.
  • disabled aurocrlf.
  • enabled plain credential store for remote.
  • added git log helper lg1 + lg2.
  • enabled bash completion for git command in integrated bash terminal.

💡 See gitconfig-system for details.

🧙 arkanum helper

Added arkanum to help installing common runtimes in container. This helps reducing the image size.

🧙 arkanum ✨🌌☄️💥 is used to install optional tools for developing in a
  code-server container environment.

  Syntax: arkanum <flags> COMMAND OPTION ARGUMENT
    config                 The config command is used to modify arkanum itself.
    git                    The git command is a wrapper for git helpers.
    install                The install command is used to add different tools
    help                   Shows this help text.

      disable-motd         Disables hint in new bash terminal.
      install extensions   Installs predefined recommended extensions.
      reset-codesettings   Sets VS Code user setting with basic (Fira Code).

      setup                Takes two arguments to setup the git client:
                             1) Username
                             2) Email address

      docker-cli           Installs the latest docker-cli.
      dotnet               Installs latest LTS dotnet core sdk + runtime.
      gitea                Installs gitea tools like the changelog generator.
      golang               Installs golang 1.19.3.
      bun                  Installs latest bun version.
      nodejs               Installs latest NodeJs LTS version using Volta.
      volta                Installs Volta as NodeJS version manager.
      powershell           Installs latest PowerShell LTS version.

  Example 1: arkanum git setup "my-name" "my-email"
  Example 2: arkanum install golang
  Example 3: arkanum config disable-motd

📝 Fira Code (NerdFont patched)

Added FiraCode as default font in editor and integrated terminal. The font files are embedded and can be used without local installation.

🦸 VSCode default settings

If your start the container or log in the first time, a default config file is deployed.

This user setting defines the following stuff:

  • Use compact menu bar to avoid users with multiple menu bars.
  • Use One Dark Pro Darker theme
  • Use vscode-icons icon set
  • Set FiraCode as default font in editor.
    • Tries to use alternate font names for FiraCode if its locally available.
  • Sets FiraCode mono variant in terminal to enable icons used by starship prompt.
  • Enables font ligatures
  • Enables auto save and format on save.
  • Disables auto update for extension.
  • Disables VSCode telemetry
  • Disable confirm message for sync branches.

Additionally we install these extensions on container startup:

💣 Known Issues

Starship detects workspaces as active python projects. It always appends the prompt fragment via 🐍 (lsiopy). For now I disabled the python module in starship.

🐛 Default extensions installation timing error

If the automatic installation of the default extension fails, you can always retry he installation with the following command:

# restart the installation
arkanum config install-extensions
# Optional: reset the vscode user setting
arkanum config reset-codesettings
# Reload with command F1 + Developer: Reload Window

😡 We're Using GitHub Under Protest

This project is currently mirrored to GitHub. This is not ideal; GitHub is a proprietary, trade-secret system that is not Free and Open Source Software (FOSS). We are deeply concerned about using a proprietary system like GitHub to develop our FOSS project. We have an open Gitea repository where the project contributors are actively discussing how we can move away from GitHub in the long term. We urge you to read about the Give up GitHub campaign from the Software Freedom Conservancy to understand some of the reasons why GitHub is not a good place to host FOSS projects.

If you are a contributor who personally has already quit using GitHub, please check this resource for how to send us contributions without using GitHub directly.

Any use of this project's code by GitHub Copilot, past or present, is done without our permission. We do not consent to GitHub's use of this project's code in Copilot.

Logo of the GiveUpGitHub campaign

🙏 Credits

Akranum is based on the following projects and wouldn't be possible without them:

⚖️ License (AGPLv3)


Arkanum - Code-Server container optimized for daily use.
Copyright (C) 2022 "OCram85 <>"

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <>.