feat: comment packaged agent and server configurations (#1)
arcad/emissary/pipeline/head This commit looks good Details

This commit is contained in:
wpetit 2023-08-25 09:32:00 -06:00
parent c51ac0adc7
commit 14eecbf01e
2 changed files with 74 additions and 5 deletions

View File

@ -1,26 +1,55 @@
# Emissary agent configuration
# Logger configuration
logger: logger:
# Logging verbosity
# DEBUG: 0
# INFO: 1
# WARN: 2
# ERROR: 3
# CRITICAL: 4
level: 1 level: 1
# Logging format
# Possible values: human, json
format: human format: human
# Agent configuration
agent: agent:
# Emissary server URL
serverUrl: http://127.0.0.1:3000 serverUrl: http://127.0.0.1:3000
# Agent private key path
privateKeyPath: /var/lib/emissary/agent-key.json privateKeyPath: /var/lib/emissary/agent-key.json
reconciliationInterval: 5 # Agent reconciliation interval (in seconds)
reconciliationInterval: 30
# Controllers configuration
controllers: controllers:
# Persistence controller configuration
persistence: persistence:
enabled: true enabled: true
stateFile: /var/lib/emissary/state.json stateFile: /var/lib/emissary/state.json
# Spec controller configuration
spec: spec:
enabled: true enabled: true
# Proxy controller configuration
proxy: proxy:
enabled: true enabled: true
# UCI controller configuration
uci: uci:
enabled: true enabled: true
binPath: uci binPath: uci
configBackupFile: /var/lib/emissary/uci-backup.conf configBackupFile: /var/lib/emissary/uci-backup.conf
# App controller configuration
app: app:
enabled: true enabled: true
dataDir: /var/lib/emissary/apps/data dataDir: /var/lib/emissary/apps/data
downloadDir: /var/lib/emissary/apps/bundles downloadDir: /var/lib/emissary/apps/bundles
# Sysupgrade controller configuration
sysupgrade: sysupgrade:
enabled: true enabled: true
sysupgradeCommand: sysupgradeCommand:
@ -33,6 +62,8 @@ agent:
- sh - sh
- -c - -c
- source /etc/openwrt_release && echo "$DISTRIB_ID-$DISTRIB_RELEASE-$DISTRIB_REVISION" - source /etc/openwrt_release && echo "$DISTRIB_ID-$DISTRIB_RELEASE-$DISTRIB_REVISION"
# Collectors configuration
collectors: collectors:
- name: uname - name: uname
command: uname command: uname

View File

@ -1,13 +1,38 @@
# Emissary server configuration
# Logger configuration
logger: logger:
# Logging verbosity
# DEBUG: 0
# INFO: 1
# WARN: 2
# ERROR: 3
# CRITICAL: 4
level: 1 level: 1
# Logging format
# Possible values: human, json
format: human format: human
# Server configuration
server: server:
# HTTP server configuration
http: http:
# Listening address (0.0.0.0 to listen on all interfaces)
host: 0.0.0.0 host: 0.0.0.0
# Listening port
port: 3000 port: 3000
# Database configuration
database: database:
# Database driver
# Possible values: sqlite
driver: sqlite driver: sqlite
# Database DSN
# sqlite: see https://github.com/mattn/go-sqlite3#connection-string
dsn: sqlite:///var/lib/emissary/data.sqlite?_pragma=foreign_keys(1)&_pragma=busy_timeout=60000 dsn: sqlite:///var/lib/emissary/data.sqlite?_pragma=foreign_keys(1)&_pragma=busy_timeout=60000
# CORS configuration
# See https://developer.mozilla.org/en/docs/Glossary/CORS
cors: cors:
allowedOrigins: [] allowedOrigins: []
allowCredentials: true allowCredentials: true
@ -22,12 +47,25 @@ server:
- Content-Type - Content-Type
- Authorization - Authorization
- Sentry-Trace - Sentry-Trace
debug: false
# Auth configuration
auth: auth:
# Local authentication configuration
local: local:
privateKeyPath: /var/lib/emissary/server-key.json privateKeyPath: /var/lib/emissary/server-key.json
roleExtractionRules:
- "jwt.role != nil ? str(jwt.role) : ''" # Remote authentication configuration
# Disabled by default
remote: ~ remote: ~
# jwksUrl: https://my-server/.well-known/jwks.json # jwksUrl: https://my-server/.well-known/jwks.json
# Role extraction rules
# Permit to derivate user's role
# from the received JWT.
#
# The first rule returning a non empty
# string will define the role of the user.
#
# The role should be 'reader' or 'writer'.
roleExtractionRules:
- "jwt.role != nil ? str(jwt.role) : ''"