Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Dashboy1998 committed Jan 31, 2024
1 parent eb4bfde commit c55c4b1
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,25 +142,31 @@ Follow the steps in the [README.md here](k8s/readme.md) to deploy it.

### Running without root

This is only recommended for advance users
This is only for advanced users

It is possible to run this container and [override the default user](https://docs.docker.com/engine/reference/run/#user) which is root in this image.
It is possible to run this container and

Check failure on line 147 in README.md

View workflow job for this annotation

GitHub Actions / Lint - Markdown

Trailing spaces

README.md:147:41 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md009.md
[override the default user](https://docs.docker.com/engine/reference/run/#user) which is root in this image.

Because you are specifiying the user and group `PUID` and `PGID` are ignored.

If you want to find your UID: `id -u`
If you want to find your GID: `id -g`

You must set user to `NUMBERICAL_UID:NUMBERICAL_GID`.

* In docker run add `--user 1000:1000 \` above the last line.
* In docker compose add `user: 1000:1000` above ports.
* In k8s add the following above the ports in deployment.yaml
Below we assume your UID is 1000 and your GID is 1001
* In docker run add `--user 1000:1001 \` above the last line.

Check failure on line 158 in README.md

View workflow job for this annotation

GitHub Actions / Lint - Markdown

Lists should be surrounded by blank lines

README.md:158 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* In docker run add `--user 10..."] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md032.md
* In docker compose add `user: 1000:1001` above ports.
* In k8s add the following above the ports in deployment.yaml

```

Check failure on line 162 in README.md

View workflow job for this annotation

GitHub Actions / Lint - Markdown

Fenced code blocks should have a language specified

README.md:162 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: " ```"] https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md040.md
securityContext:
runAsUser: 1000
runAsGroup: 1000
runAsGroup: 1001
```

If you wish to run it with a different UID/GID than your own you will need to change the ownership of the directory that is being bind: `chown UID:GID palworld/`
If you wish to run it with a different UID/GID than your own you will need to change the ownership of the directory that
is being bind: `chown UID:GID palworld/`
or by changing the permissions for all other: `chmod o=rwx palworld/`

#### Using helm chart
Expand Down

0 comments on commit c55c4b1

Please sign in to comment.