tec3/ublue-forge
tec3/ublue-forge
1
0
Fork 0
mirror of https://github.com/ublue-os/forge.git synced 2025-07-07 18:25:46 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc(main): updates

Browse source
This commit is contained in:
Stephan Lüscher 2024-05-27 16:42:33 +00:00
parent e0df50076e
commit ee86b81f5b
No known key found for this signature in database
GPG key ID: 445779060FF3D3CF
2 changed files with 22 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/index.md
View file

@ -41,21 +41,24 @@ ln -s $FORGE_POD_DATA_DIR $HOME/ublue-os_forge-data
With this the data folder would be available in your home directory under `~/ublue-os_forge-data`
In that folder you will find an example configuration similar to this:
In that folder you will find an **examples** folder with example configurations similar to this:
```yaml
## ublue-os forge extra-vars example configuration
## ublue-os forge example configuration
## For more details got to https://github.com/ublue-os/forge/blob/main/docs/variables.md
---
forge_git_repository_url: https://github.com/ublue-os/bluefin.git
forge_git_repository_destination: /var/home/stephan/.local/share/containers/storage/volumes/ublue-os_forge-data/_data/data/bluefin
forge_git_repository_version: main
forge_registry_url: registry.ublue.local
forge_git_repository_destination: "/var/home/stephan/.local/share/containers/storage/volumes/ublue-os_forge-data/_data/data/bluefin"
forge_container_extra_args:
- --build-arg="BASE_IMAGE_NAME=silverblue"
- --build-arg="IMAGE_FLAVOR=main"
- --build-arg="AKMODS_FLAVOR=main"
- --build-arg="FEDORA_MAJOR_VERSION=39"
- --build-arg="TARGET_BASE=bluefin"
```
This file acts as a template. It has all available settings outlined for you. Simple copy
it and modify it to your liking. For each project you want to handle with the forge you can
create a dedicated file.
These files are a good starting point for your custom configuration. Simple copy those examples
you are interested in modify them to your liking.
Details about the available variables are documented [here](./variables.md).