ytti/oxidized

I would like to see an explanation of each setting item in the oxidized config in the document.

ts0818 opened this issue · 4 comments

I would like an explanation of what values should be set for each setting item in the oxidized config. It is not clear which values are related to router.db from the information in the current document.

▼ Target documents
https://github.com/ytti/oxidized/blob/master/docs/Configuration.md

From what I can see, everything is explained in the documentation. If you want detailed information about each configuration setting for Oxidized, here’s a general guide:

  • For misc configuration, refer to the Configuration.md.
  • If you’re looking for hooks (e.g., for notifications or events after configuration changes), go to docs/hooks.md.
  • For information related to outputs (how and where configuration backups are stored), check out docs/outputs.md.
  • If you're working with router.db-related settings (which is often tied to your source configuration), refer to docs/source.md. This is where you define how Oxidized pulls device information (from a file, HTTP, or another system like NetBox).

Each section of the documentation is broken down by feature, so navigate accordingly depending on what you need to configure.

Thank you for your reply.

This question was based on the assumption that there was no list of setting items like the one below.

https://docs.spring.io/spring-boot/appendix/application-properties/index.html

There was no explanation of each item in the "Oxidized" document that you collaborated with,
I did not know the total number of items that can be set, so I checked.

I'll work on creating YARD documentation that is hopefully better and more comprehensive.

Thank you for your reply.

Thank you for your consideration.
I would appreciate it if you could create a document that even a first-time reader can understand.