1"use strict";(globalThis.webpackChunkmy_website=globalThis.webpackChunkmy_website||[]).push([[5909],{48193:(e,n,i)=>{i.d(n,{R:()=>t,x:()=>a});var o=i(30758);const s={},r=o.createContext(s);function t(e){const n=o.useContext(r);return o.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:t(e.components),o.createElement(r.Provider,{value:n},e.children)}},71011:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>a,default:()=>h,frontMatter:()=>t,metadata:()=>o,toc:()=>c});const o=JSON.parse('{"id":"basics/configuration","title":"Configuration","description":"Configuration sources","source":"@site/versioned_docs/version-v3/basics/configuration.md","sourceDirName":"basics","slug":"/basics/configuration","permalink":"/docs/v3/basics/configuration","draft":false,"unlisted":false,"editUrl":"https://github.com/distribworks/dkron/tree/main/website/docs/versioned_docs/version-v3/basics/configuration.md","tags":[],"version":"v3","frontMatter":{},"sidebar":"tutorialSidebar","previous":{"title":"Getting started","permalink":"/docs/v3/basics/getting-started"},"next":{"title":"Installation","permalink":"/docs/v3/basics/installation"}}');var s=i(86070),r=i(48193);const t={},a="Configuration",l={},c=[{value:"Configuration sources",id:"configuration-sources",level:2},{value:"Config file location",id:"config-file-location",level:2},{value:"Config file example",id:"config-file-example",level:3},{value:"SEE ALSO",id:"see-also",level:3}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"configuration",children:"Configuration"})}),"\n",(0,s.jsx)(n.h2,{id:"configuration-sources",children:"Configuration sources"}),"\n",(0,s.jsx)(n.p,{children:"Settings can be specified in three ways (in order of precedence):"}),"\n",(0,s.jsxs)(n.ol,{children:["\n",(0,s.jsx)(n.li,{children:"Command line arguments."}),"\n",(0,s.jsxs)(n.li,{children:["Environment variables starting with ",(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"DKRON_"})})]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.strong,{children:(0,s.jsx)(n.code,{children:"dkron.yml"})})," config file"]}),"\n"]}),"\n",(0,s.jsx)(n.admonition,{type:"caution",children:(0,s.jsxs)(n.p,{children:["Dkron sends anonymous usage data to a server with the purpose of elaborating usage statistics, if you want to disable statistics collection, you can disable it in the dkron config file or in the command line using ",(0,s.jsx)(n.code,{children:"--disable-usage-stats"})," parameter"]})}),"\n",(0,s.jsx)(n.h2,{id:"config-file-location",children:"Config file location"}),"\n",(0,s.jsx)(n.p,{children:"Config file will be loaded from the following paths:"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"/etc/dkron"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"$HOME/.dkron"})}),"\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.code,{children:"./config"})}),"\n"]}),"\n",(0,s.jsx)(n.h3,{id:"config-file-example",children:"Config file example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-yaml",children:'# Dkron example configuration file\n# server: false\n# bootstrap-expect: 3\n# data-dir: dkron.data\n# log-level: debug\n# tags:\n# dc: east\n# encrypt: a-valid-key-generated-with-dkron-keygen\n# retry-join:\n# - 10.0.0.1\n# - 10.0.0.2\n# - 10.0.0.3\n# raft-multiplier: 1\n# webhook-url: https://hooks.slack.com/services/XXXXXX/XXXXXXX/XXXXXXXXXXXXXXXXXXXX\n# webhook-payload: "payload={\\"text\\": \\"{{.Report}}\\", \\"channel\\": \\"#foo\\"}"\n# webhook-headers: Content-Type:application/x-www-form-urlencoded\n# mail-host: email-smtp.eu-west-1.amazonaws.com\n# mail-port: 25\n# mail-username": mailuser\n# mail-password": mailpassword\n# mail-from": [email protected]\n# mail-subject_prefix: [Dkron]\n'})}),"\n",(0,s.jsx)(n.h3,{id:"see-also",children:"SEE ALSO"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/docs/cli/dkron_agent/",children:"dkron agent"}),"\t - Start a dkron agent"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/docs/cli/dkron_doc/",children:"dkron doc"}),"\t - Generate Markdown documentation for the Dkron CLI."]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/docs/cli/dkron_keygen/",children:"dkron keygen"}),"\t - Generates a new encryption key"]}),"\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/docs/cli/dkron_version/",children:"dkron version"}),"\t - Show version"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(d,{...e})}):d(e)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.