Skip to content

Server Configuration

Jump to bottom
Max Harley edited this page Sep 4, 2019 · 1 revision

Configuration Paths

Satellite looks for server configuration in

  • $HOME/.config/satellite/config.yml
  • $HOME/.satellite/config.yml
  • /etc/satellite/config.yml

Example Configuration

server_root: /var/www/html
listen: 127.0.0.1:8080
index: /index.html
log_level: debug

not_found:
  redirect: https://amazon.com

server_header: Apache/2.4.1 (Unix)

management:
  ip: 127.0.0.1
  path: /management

ssl:
  key: /home/<user>/.config/satellite/keys/key.unencrypted.pem
  cert: /home/<user>/.config/satellite/keys/cert.pem

Configuration Values

Key Configuration
server_root Server root directory. Defaults to /var/www/html
listen IP:port combination to listen on. If this IP is removed, the service will listen on 0.0.0.0. Defaults to 127.0.0.1:8080
server_header Server header to give clients when requesting a page
management.ip IP (or range) which is allowed to view the management portal
management.path Management server URL path. If this option is not specified, the route does not get created. Takes precedence over any already-existing paths
ssl.key SSL key path
ssl.cert SSL cert path
index Index path for when a user requests /
not_found.redirect Redirect to give page when a page isn't found
not_found.render Path of file to render when a page isn't found
log_level Minimum log level. Options are panic, fatal, error, warn, info, debug, trace
Clone this wiki locally