spkrepo
Synology Package Repository
Development
Requirements
- Install docker and docker-compose
- Install uv
- Install pre-commit e.g.
uv tool install pre-commit
Installation
- Run postgres, e.g. using docker with
docker compose up db - Install dependencies with
uv sync - Create the tables with
uv run flask db upgrade - Populate the database with some fake packages with
uv run flask spkrepo populate_db - Add an admin account with
uv run flask spkrepo create_admin -u admin -e admin@synocommunity.com -p adminadmin
To clean data created by fake packages, run uv run flask spkrepo depopulate_db
Run
- Start postgres with
docker compose up db - Start the development server with
uv run flask run - Website is available at http://localhost:5000
- Admin interface is available at http://localhost:5000/admin
- NAS interface is available at http://localhost:5000/nas
- API is available at http://localhost:5000/api
- Run the test suite with
uv run pytest -v
spkrepo CLI Usage
Usage: flask spkrepo [OPTIONS] COMMAND [ARGS]...
Spkrepo admin commands.
Options:
--help Show this message and exit.
Commands:
clean Clean data path.
create_admin Create a new admin user.
create_user Create a new user with an activated account.
depopulate_db Depopulate database.
populate_db Populate the database with some packages.
- Add a user with
uv run flask spkrepo create_user -u admin -e admin@synocommunity.com -p adminadmin - Grant the created user with Administrator permissions
uv run flask roles add admin@synocommunity.com admin - Grant the created user with Package Administrator permissions
uv run flask roles add admin@synocommunity.com package_admin - Grant the created user with Developer permissions
uv run flask roles add admin@synocommunity.com developer
Docker Compose Run
- If you also want to run the app in docker you can with
docker compose up app - You can run both postgres and the app with
docker compose up
Deployment
Configuration
Create a config file ./config.py to disable debug logs, connect to a database, set a secure key and optionally set a cache:
Use LC_CTYPE=C tr -cd '[:print:]' < /dev/urandom | head -c 64 or base64 < /dev/urandom | head -c 64 to get a random string
DEBUG = False
TESTING = False
SECRET_KEY = "Please-change-me-to-some-random-string"
SQLALCHEMY_ECHO = False
SQLALCHEMY_DATABASE_URI = "postgresql://user:pass@localhost/dbname"
# https://pythonhosted.org/Flask-Caching/#configuring-flask-caching
CACHE_TYPE= "SimpleCache"
# For signing packages
GNUPG_PATH= "/usr/local/bin/gpg"
Run Tests & Linters
uv run pytest -v
uvx pre-commit run --all-files
Docker
Example usage:
docker run -it --rm --name spkrepo -v $(pwd)/data:/data -p 8000:8000 ghcr.io/synocommunity/spkrepo
Additional configuration can be mounted in the container and loaded by putting
the path into SPKREPO_CONFIG environment variable.
e.g.
docker run -it --rm --name spkrepo -v $(pwd)/data:/data -v $(pwd)/docker-config.py:/docker-config.py -e SPKREPO_CONFIG=/docker-config.py -p 8000:8000 ghcr.io/synocommunity/spkrepo
Serve app via a WSGI server.
Example:
# Production
SPKREPO_CONFIG="$PWD/config.py" gunicorn -w 4 'wsgi:app'
# Development
SPKREPO_CONFIG="$PWD/config.py" uv run gunicorn -b 0.0.0.0:8080 -w 4 wsgi:app
Add migration
uv run flask db revision -m "update build path length"
Test NAS API
curl "http://localhost:5000/nas?package_update_channel=beta&build=24922&language=enu&major=6µ=2&arch=x86_64&minor=2"
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
spkrepo-0.6.9.tar.gz
(737.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
spkrepo-0.6.9-py3-none-any.whl
(689.9 kB
view details)
File details
Details for the file spkrepo-0.6.9.tar.gz.
File metadata
- Download URL: spkrepo-0.6.9.tar.gz
- Upload date:
- Size: 737.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2413aca62024c7d1a307f99a254aaa1a6af25dd575073e340b439d056e4f9c33
|
|
| MD5 |
ab3c624acfcd347534d717fba41083d3
|
|
| BLAKE2b-256 |
274409919ffa49e9edc832c9f8fd005618b0a80908486063ef3ddab71c1c6561
|
File details
Details for the file spkrepo-0.6.9-py3-none-any.whl.
File metadata
- Download URL: spkrepo-0.6.9-py3-none-any.whl
- Upload date:
- Size: 689.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.11.23 {"installer":{"name":"uv","version":"0.11.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
56da6e0ba927f9e0f527826ad8bd485bc8189578be50372d78fb12a93bbcb962
|
|
| MD5 |
b3a3b46f7286c8c2b1db4714fe1f6ba0
|
|
| BLAKE2b-256 |
fcbaff64c81b0ed81e6fa985b87c05f0d7206621f3fac36655fcbc6d97dcc1f8
|
