diff --git a/README.md b/README.md index f8c6d11d..5dca14a5 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,10 @@ The software packages managed by gooseBit are either stored on the local filesys ## Assumptions -- Devices use [SWUpdate](https://swupdate.org) for managing software updates. +- Devices use [SWUpdate](https://swupdate.org) or [RAUC](https://github.com/rauc/rauc) + [RAUC hawkBit Updater](https://github.com/rauc/rauc-hawkbit-updater) for managing software updates. +- Devices send certain attributes (`sw_version`, `hw_model`, `hw_revision`). +- Semantic versions are used. +- With RAUC and multiple hardware revisions, `compatible` in `manifest.raucm` is set to something like `my-board-rev4.2` or `Some Board 2b`. ## Features @@ -78,7 +81,7 @@ The registry tracks each device's status, including the last online timestamp, i ### Software Repository -Software packages (`*.swu` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions. +Software packages (`*.swu`/`*.raucb` files) can be hosted directly on the gooseBit server or on an external server. gooseBit parses the software metadata to determine compatibility with specific hardware models and revisions. ### Device Update Modes @@ -235,7 +238,7 @@ The structure of gooseBit is as follows: - `templates`: Jinja2 formatted templates. - `nav`: Navbar handler. - `updater`: DDI API handler and device update manager. -- `updates`: SWUpdate file parsing. +- `updates`: SWUpdate/RAUC file parsing. - `auth`: Authentication functions and permission handling. - `models`: Database models. - `db`: Database config and initialization. diff --git a/goosebit.yaml b/goosebit.yaml index 6b6e7948..e900104f 100644 --- a/goosebit.yaml +++ b/goosebit.yaml @@ -10,6 +10,16 @@ #db_uri: sqlite:////db.sqlite3 #db_ssl_crt: //ca-certificate.crt +# Storage settings (default backend is "filesystem") +#storage: +# backend: s3 +# s3: +# bucket: goosebit +# region: us-east-1 +# endpoint_url: http://localhost:9000 # example for self-hosted min.io +# access_key_id: minioadmin +# secret_access_key: minioadmin + # Path to the directory containing artifact files, default: #artifacts_dir: //artifacts @@ -89,12 +99,3 @@ logging: root: level: INFO handlers: [console] -# Storage settings (default backend is filesystem) -# storage: -# backend: s3 -# s3: -# bucket: goosebit -# # region: us-east-1 -# # endpoint_url: http://localhost:9000 # example for self-hosted min.io -# access_key_id: minioadmin -# secret_access_key: minioadmin diff --git a/pyproject.toml b/pyproject.toml index ea3b6278..3e836b7c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "goosebit" -version = "0.2.8" +version = "0.2.9" description = "A simplistic, opinionated remote update server implementing hawkBit™'s DDI API" authors = [ {name = "Brett Rowan", email = "121075405+b-rowan@users.noreply.github.com"}