gtsocial-umbx

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

syslog.md (1555B)


      1 # Syslog
      2 
      3 GoToSocial can be configured to mirror logs to [syslog](https://en.wikipedia.org/wiki/Syslog), either via udp/tcp, or a local syslog (eg., `/var/log/syslog`).
      4 
      5 This is useful if you want to daemonize GtS and not handle log rotations etc yourself but rely on a proven implementation.
      6 
      7 Logs in syslog will look something like this:
      8 
      9 ```text
     10 Dec 12 17:44:03 dilettante ./gotosocial[246860]: time=2021-12-12T17:44:03+01:00 level=info msg=connected to SQLITE database
     11 Dec 12 17:44:03 dilettante ./gotosocial[246860]: time=2021-12-12T17:44:03+01:00 level=info msg=there are no new migrations to run func=doMigration
     12 ```
     13 
     14 ## Settings
     15 
     16 ```yaml
     17 #########################
     18 ##### SYSLOG CONFIG #####
     19 #########################
     20 
     21 # Config for additional syslog log hooks. See https://en.wikipedia.org/wiki/Syslog,
     22 # and https://github.com/sirupsen/logrus/tree/master/hooks/syslog.
     23 #
     24 # These settings are useful when one wants to daemonize GoToSocial and send logs
     25 # to a specific place, either a local location or a syslog server. Most users will
     26 # not need to touch these settings.
     27 
     28 # Bool. Enable the syslog logging hook. Logs will be mirrored to the configured destination.
     29 # Options: [true, false]
     30 # Default: false
     31 syslog-enabled: false
     32 
     33 # String. Protocol to use when directing logs to syslog. Leave empty to connect to local syslog.
     34 # Options: ["udp", "tcp", ""]
     35 # Default: "tcp"
     36 syslog-protocol: "udp"
     37 
     38 # String. Address:port to send syslog logs to. Leave empty to connect to local syslog.
     39 # Default: "localhost:514"
     40 syslog-address: "localhost:514"
     41 ```