spiegel/docs/config
Ada f47bbeaaea
Some checks failed
ci/woodpecker/push/test Pipeline was successful
ci/woodpecker/push/lint Pipeline failed
Support ssh clone
2024-05-22 03:01:10 +02:00
..
README.adoc Support ssh clone 2024-05-22 03:01:10 +02:00

= Configuration

File format used is https://toml.io/en/[toml]. You can specify config file in first argument. (ex: `./spiegel different.toml)`). Default path is `config.toml`

== Options:
* `clonedirectory`: Directory where mirror is clone
* `interval`: Update interval in minute
* `log`: Log config section
** `level`: Log level, allowed value is: "DEBUG", "INFO", "WARN", "ERROR", "FATAL"
** `file`: Log file, default (empty) is in stderr
** `RepoList`: List of mirrored git repository
*** `URL`: Source URL. You can use `https://<user>:<password>@git.example/repo.git` if you want http basic auth.
*** `name`: directory name of clone
*** `SSHKey`: SSH key for clone via ssh

== Example:
[source,toml]
----
include::../../config.example.toml[]
----