Add config.yml.example

[ashmckenzie]

This PR adds a basic yet working config.yml.example to make getting started a little easier. I also fixed a few config.yaml -> config.yml references in the docs 🙂

Perhaps we should include something in the README.md or such about copying config.yml.example to config.yml as well ?

cc @0xERR0R

[ThinkChaos]

AFAICT docs/config.yml should already cover this. It's embedded in the doc's config page.
Is there a reason it doesn't?

Maybe we can add a link in the README to help discoverability.

[ashmckenzie]

Thanks @ThinkChaos for pointing out docs/config.yml's existence. docs/config.yml is a more comprehensive example that needs redis (and potentially other things) setup to work, where as the config.yml.example is a bare bones minimum that works as-is:

$ cd ~/src/blocky
$ cp docs/config.yml .
$ make run
go install github.com/abice/[email protected]
go generate ./...
go-enum started. file: config.go
go-enum finished. file: config.go
go-enum started. file: list_cache.go
go-enum finished. file: list_cache.go
go-enum started. file: logger.go
go-enum finished. file: logger.go
go-enum started. file: models.go
go-enum finished. file: models.go
go build -v -ldflags="-w -s -X github.com/0xERR0R/blocky/util.Version=v0.18-112-g50ac5ce -X github.com/0xERR0R/blocky/util.BuildTime=20220723-121057" -o bin/blocky
./bin/blocky
[2022-07-23 12:11:01]  INFO _/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
[2022-07-23 12:11:01]  INFO _/                                                              _/
[2022-07-23 12:11:01]  INFO _/                                                              _/
[2022-07-23 12:11:01]  INFO _/       _/        _/                      _/                   _/
[2022-07-23 12:11:01]  INFO _/      _/_/_/    _/    _/_/      _/_/_/  _/  _/    _/    _/    _/
[2022-07-23 12:11:01]  INFO _/     _/    _/  _/  _/    _/  _/        _/_/      _/    _/     _/
[2022-07-23 12:11:01]  INFO _/    _/    _/  _/  _/    _/  _/        _/  _/    _/    _/      _/
[2022-07-23 12:11:01]  INFO _/   _/_/_/    _/    _/_/      _/_/_/  _/    _/    _/_/_/       _/
[2022-07-23 12:11:01]  INFO _/                                                    _/        _/
[2022-07-23 12:11:01]  INFO _/                                               _/_/           _/
[2022-07-23 12:11:01]  INFO _/                                                              _/
[2022-07-23 12:11:01]  INFO _/                                                              _/
[2022-07-23 12:11:01]  INFO _/  Version: v0.18-112-g50ac5ce Build time: 20220723-121057     _/
[2022-07-23 12:11:01]  INFO _/                                                              _/
[2022-07-23 12:11:01]  INFO _/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/_/
Error: can't start server: dial tcp: lookup redis: no such host
make: *** [run] Error 1

I think it's great to have a 'kitchen sink' example as well as a 'bare bones' example, the former is great for knowing what options are available and the latter is great for getting started fast.

[0xERR0R]

As mentioned by @ThinkChaos "docs/config.yml" is the reference config file with all parameters (https://0xerr0r.github.io/blocky/configuration/)

I think you want a minimal configuration file, just to be able to run blocky, right? Maybe we can provide a "TL;DR" section in https://0xerr0r.github.io/blocky/ and/or README.md?

[github-actions[bot]]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

[ThinkChaos]

I think this might be better solved by implementing #380, and skipping the cp docs/config.yml . step.

[github-actions[bot]]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

[github-actions[bot]]

This PR was closed because it has been stalled for 10 days with no activity.