Archweb README

To get a pretty version of this document, run

$ markdown README > README.html

License

See LICENSE file.

Authors

See AUTHORS file.

Dependencies

• Python 3.13.0
• UV
• rsync (optional for mirrorcheck with rsync mirrors)

Python dependencies

You can look at the packages archweb uses by looking at the pyproject.toml file; it is best to use uv to handle these. If you insist on (Arch Linux) packages, you probably want the following:

• python-django
• python-psycopg2
• python-markdown
• python-memcached

Testing Installation

1. Run uv sync.

2. Initialize git submodules:

    git submodule update --init --recursive
   

3. Activate the virtualenv.

4. Copy local_settings.py.example to local_settings.py and modify.

   • Make sure to uncomment the appropriate database section (either sqlite or PostgreSQL).
   • set DEBUG = True or keep it set to False and set ALLOWED_HOSTS = ['localhost', '127.0.0.1', '[::1]']
   • if you keep DEBUG = False, make static assets available with uv run ./manage.py collectstatic --noinput

5. Migrate changes.

    uv run ./manage.py migrate
   

6. Load the fixtures to pre-populate some data. If you don't want some of the provided data, adjust the file glob accordingly.

    uv run ./manage.py loaddata main/fixtures/*.json
    uv run ./manage.py loaddata devel/fixtures/*.json
    uv run ./manage.py loaddata mirrors/fixtures/*.json
    uv run ./manage.py loaddata releng/fixtures/*.json
   

7. Use the following commands to start a service instance:

    uv run ./manage.py runserver
   

8. Populate the database with real data (optional) You can optionally populate your database with real package data from an Arch Linux mirror:

    wget https://geo.mirror.pkgbuild.com/core/os/x86_64/core.db.tar.gz
    uv run ./manage.py reporead x86_64 core.db.tar.gz
    # Package file listing
    wget https://geo.mirror.pkgbuild.com/core/os/x86_64/core.files.tar.gz
    uv run ./manage.py reporead --filesonly x86_64 core.files.tar.gz
   

   Customization notes: Modify the URL path and architecture argument (x86_64) if you need a different architecture or repository (e.g., extra). If the default mirror experiences downtime or slow speeds, you can swap the base URL with another mirror. Find a complete, up-to-date list of active mirrors at the Arch Linux Mirror Status page.

9. Database Updates for Added/Removed packages

    sqlite3 archweb.db < packages/sql/update.sqlite3.sql
   

   For PostgreSQL use packages/sql/update.postgresql_psycopg2.sql

Testing SMTP server

To be able to create an account on your test environment an SMTP server is required. A simple debugging SMTP server can be setup using Python and aiosmtpd.

Install smtp group

    uv sync --group smtp

Run the server

    uv run python -m aiosmtpd -n -l localhost:1025

In local_settings.py add entries to set EMAIL_HOST to 'localhost' and EMAIL_PORT to 1025.

Running tests and coverage

To run unittests execute the following commands:

    make collectstatic
    make test

Running coverage:

    make coverage
    make open-coverage

Django Debug toolbar

To use the Django Debug toolbar install django-debug-toolbar and in local_settings.py set DEBUG_TOOLBAR to True.

Management commands

Archweb provides multiple management commands for importing various sorts of data. An overview of commands:

• generate_keyring - Assemble a GPG keyring with all known developer keys.
• pgp_import - Import keys and signatures from a given GPG keyring.
• read_rebuilderd_status - Import rebuilderd status into Archweb.
• rematch_developers - Rematch flag requests and packages where user_id/packager_id is NULL to a Developer.
• reporead - Parses a repo.db.tar.gz, repo.files.tar.gz file and updates the Arch database with the relevant changes.
• reporead_inotify - Watches a templated patch for updates of *.files.tar.gz to update Arch databases with.
• donor_import - Import a single donator from a mail passed to stdin
• mirrorcheck - Poll every active mirror URLs to store the lastsnyc time and record network timing details.
• mirrorresolv - Poll every active mirror URLs and determine whether they have IP4 and/or IPv6 addresses.
• populate_signoffs - retrieves the latest commit message of a signoff-eligible package.
• update_planet - Import all feeds for users who have a valid website and website_rss in their user profile.
• read_links - Reads a repo.links.db.tar.gz file and updates the Soname model.
• read_links_inotify - Watches a templated patch for updates of *.links.tar.gz to update Arch databases with.
• read_bumpbuddy_status - Imports the bumpbuddy out of date status.

Updating iPXE images

The binaries required for iPXE based netboot are updated by copying them from the ipxe package to the static content directory (with the run_ipxe script the binaries may be tested beforehand):

cp -v /usr/share/ipxe/x86_64/ipxe-arch.efi /usr/share/ipxe/ipxe-arch.{ipxe,lkrn} sitestatic/releng

Afterwards a detached PGP signature using a valid WKD enabled packager key is created for each file:

for artifact in sitestatic/netboot/*.{efi,pxe,lkrn}; do
  gpg --sender "User Name <your@mail.address>" --detach-sign "$artifact"
done

Production Installation

Arch Linux has an Ansible role for Archweb in their infrastructure repo.

vim: set syntax=markdown et: