github-starred/komodo
2
0
Fork 1
mirror of https://github.com/moghtech/komodo.git synced 2026-04-29 04:10:01 -05:00
Code Issues 3.1k Packages Projects Releases 103 Wiki Activity

update docs for ghcr

Browse Source
This commit is contained in:
mbecker20
2024-06-09 21:56:01 -07:00
parent 6bada46841
commit e7891f7870
3 changed files with 17 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docsite/docs/build-images/configuration.md
View File

@@ -18,7 +18,20 @@ If the build directory is the root of the repository, you pass the build path as
The dockerfile's path is given relative to the build directory. So if your build directory is `build/directory` and the dockerfile is in `build/directory/Dockerfile.example`, you give the dockerfile path simply as `Dockerfile.example`.
Just as with private repos, you will need to select a docker account to use with `docker push`.
### Image registry
Monitor supports pushing to DockerHub and Github Container Registry (ghcr.io).
Any of the Docker / Github accounts that are specified in config, between the core config and builder, will be available to use.
Additionally, allowed organizations for both DockerHub and Github can be specified on the core config and attached to builds.
Doing so will cause the images to be published under the organization's namespace rather than the account's.
When connecting a build to a deployments, the default behavior is for the deployment to inherit the registry configuration from the build.
In cases where that account isn't available to the deployment, another account can be chosen in the deployment config.
:::note
In order to publish to the Github Container Registry, your Github access token must be given the `write:packages` permission.
See the Github docs [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).
:::
### Adding build args

4
docsite/docs/core-setup.md
View File

@@ -25,13 +25,13 @@ See [config docs](https://docs.rs/monitor_client/latest/monitor_client/entities/
## 2. Start monitor core
Monitor core is distributed via dockerhub under the public repo [mbecker2020/monitor_core](https://hub.docker.com/r/mbecker2020/monitor_core).
Monitor core is distributed via Github Container Registry under the package [mbecker20/monitor_core](https://github.com/mbecker20/monitor/pkgs/container/monitor_core).
```sh
docker run -d --name monitor-core \
-v $HOME/.monitor/core.config.toml:/config/config.toml \
-p 9000:9000 \
mbecker2020/monitor_core
ghcr.io/mbecker20/monitor_core
```
## First login

2
docsite/docs/deploy-containers/configuration.md
View File

@@ -12,7 +12,7 @@ By default, Monitor will deploy the latest available version of the build, or yo
Also by default, Monitor will use the same docker account that is attached to the build in order to pull the image on the periphery server. If that account is not available on the server, you can specify another available account to use instead, this account just needs to have read access to the docker repository.
### Using a custom image
You can also manually specify an image name, like `mongo` or `mbecker2020/random_image:0.1.1`.
You can also manually specify an image name, like `mongo` or `ghcr.io/mbecker20/random_image:0.1.1`.
If the image repository is private, you can still select an available docker account to use to pull the image.