Skip to content

Commit

Permalink
Updated Readme to reflect changes
Browse files Browse the repository at this point in the history
  • Loading branch information
TeamLinux01 committed Aug 24, 2024
1 parent 0948b60 commit e7abd30
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

1. Create a repo for your [personal github pages](https://pages.github.com).
1. Fork this repo.
1. Change any references to `daniel.melzaks.com` in the readme, `podman.env` and anywhere else.
1. Change any references to `daniel.melzaks.com` in the repo.
1. Remove all `.md` files from `content` folder, modify the `hugo.yaml`

### How to test your site
Expand All @@ -17,9 +17,7 @@

## How to setup

```
git clone --recurse-submodules -j8 [email protected]:TeamLinux01/daniel.melzaks.com.git
```
`git clone` the forked repo.

### How to edit

Expand All @@ -29,8 +27,13 @@ git clone --recurse-submodules -j8 [email protected]:TeamLinux01/daniel.melzaks.com

### How to publish

> Make sure to edit the `podman.env` file for your container registry, username and image name before running the script.
> There are a few github secerts that need to be added for the Github Actions. It expects to upload to Docker Hub.
1. Run the `build_website.sh` script.
1. Pull the image from the container registry on your server.
1. Run the container image and use a reverse proxy container to add TLS.
#### List of secerts in Github repo

* DOCKERHUB_USERNAME
* DOCKERHUB_TOKEN

`DOCKER_USERNAME` is the [Docker Hub](https://hub.docker.com/) username.

`DOCKERHUB_TOKEN` is the [Docker Hub Token](https://docs.docker.com/security/for-developers/access-tokens/#create-an-access-token). It should have a scope of `Read & Write`.

0 comments on commit e7abd30

Please sign in to comment.