Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • ec325a8
  • /
  • docker
  • /
  • byceps
  • /
  • config.toml.example
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:3adadd142b2db906cfd05e3bda904039d93d51c1
directory badge
swh:1:dir:b14963bdae6618c11573e5d3f47e347fc4c80193

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
config.toml.example
# Exemplary production configuration for Docker

locale = "en"
# Set a custom secret key before running in production!
# To generate a secret key, run:
#     $ docker compose run --rm byceps-apps uv run byceps generate-secret-key
secret_key = ""
timezone = "Europe/Berlin"

[apps]
admin = { server_name = "admin.byceps.example" }
api = { server_name = "api.byceps.example" }
sites = [
  { server_name = "cozylan.example", site_id = "cozylan" },
]

[database]
host = "db"
port = 5432
username = "byceps"
password = "byceps"
database = "byceps"

#[development]
#style_guide_enabled = false
#toolbar_enabled = false

#[discord]
#enabled = false
#client_id = "discord-client-id"
#client_secret = "discord-client-secret"

#[metrics]
#enabled = false

#[payment_gateways.paypal]
#enabled = false
#client_id = "paypal-client-id"
#client_secret = "paypal-client-secret"
#environment = "sandbox"

#[payment_gateways.stripe]
#enabled = false
#secret_key = "stripe-secret-key"
#publishable_key = "stripe-publishable-key"
#webhook_secret = "stripe-webhook-secret"

[redis]
url = "redis://redis/0"

[smtp]
#host = "localhost"
#port = 25
#starttls = true
#use_ssl = true
#username = "smtp-user"
#password = "smtp-password"
#suppress_send = false

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API