Skip to content

Commit

Permalink
fix: rename configuration file to config.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
yankeguo committed Jul 23, 2024
1 parent 63f6685 commit d9b6a70
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,14 @@ Visit [GitHub Releases](https://github.com/yankeguo/bunker/releases) and downloa

Static assets are embedded in the binary, so you don't need to download anything else.

- Prepare a `data` directory and put `bunker.yaml` configuration file in it
- Prepare a `data` directory and put `config.yaml` configuration file in it
- Run `bunker --data-dir data`

### From Container Image

Visit [DockerHub Repository](https://hub.docker.com/repository/docker/yankeguo/bunker) or [GitHub Packages](https://github.com/yankeguo?tab=packages&repo_name=bunker) for container images

- Prepare a `data` directory and put `bunker.yaml` configuration file in it
- Prepare a `data` directory and put `config.yaml` configuration file in it
- Run contaienr image with `/data` mounted, `docker run -p 8080:8080 -p 8022:8022 -v $PWD/data:/data yankeguo/bunker:latest`

## Initial Users
Expand All @@ -36,7 +36,7 @@ password: guest
## Configuration File
Prepare a `bunker.yaml` file
Prepare a `config.yaml` file

```yaml
ui: # for display only
Expand Down
2 changes: 1 addition & 1 deletion cmd/bunker/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func main() {
return &fxevent.ZapLogger{Logger: log}
}),

ufx.ProvideConfFromYAMLFile(filepath.Join(optDataDir, "bunker.yaml")),
ufx.ProvideConfFromYAMLFile(filepath.Join(optDataDir, "config.yaml")),
ufx.Module,

fx.Provide(
Expand Down

0 comments on commit d9b6a70

Please sign in to comment.