reference.pxls.conf

// The canvas code, especially useful for external sites to know that the canvas has rolled over
canvascode: "1"

server {
  port: 4567

  // The directory the server places board files and backups in
  storage: .

  // If you're using a reverse proxy, you need to set this up to identify the users' real IPs
  // If the connecting client's IP matches "server.proxy.localhosts", it will look up each header in the "headers" field
  // in sequence until it finds a non-local IP, and will use that IP throughout for rate limiting and storage
  proxy {
    // If you have a custom load balancer, reverse proxy, DDoS protector, etc, put its IP in here
    localhosts: ["127.0.0.1", "0:0:0:0:0:0:0:1"]
    headers: []
  }

  limits {
    // time is a rate limit time frame
    // count is how many times a request can be made in that time frame before 429ing
    signup {
      count: 4
      time: 1h
    }

    auth {
      count: 3
      time: 10m
    }

    lookup {
      count: 20
      time: 2m
    }

    undo {
      count: 3
      time: 1m
    }

    chat {
      count: 2
      time: 1s
    }
  }
}

html {
  title: Pxls
  head: ""
  info: "resource:/public/info.html"
}

database {
  // The driver to use, currently only mysql is supported
  driver: mysql

  user: ""
  pass: ""

  // The URI of the format "mariadb://<host>:<port>/<db>"
  // Example: "mariadb://localhost:3306/pxls"
  url: ""
}

pixelCounts {
  countTowardsAlltime: true,
  countTowardsCurrent: true
}

board {
  width: 1000
  height: 1000
  palette: [
    "#FFFFFF",
    "#E4E4E4",
    "#888888",
    "#222222",
    "#FFA7D1",
    "#E50000",
    "#E59500",
    "#A06A42",
    "#E5D900",
    "#94E044",
    "#02BE01",
    "#00D3DD",
    "#0083C7",
    "#0000EA",
    "#CF6EE4",
    "#820080"
  ]
  defaultColor: 0
  // See cooldown below
  heatmapCooldown: 3h
  saveInterval: 5s
  backupInterval: 5m
}

// See https://github.com/typesafehub/config/blob/master/HOCON.md#duration-format
// raw numbers will be interpreted as milliseconds
cooldown: 3m
useStaticCooldown: false
undo {
  window: 5s
}

// Cooldown increase based on authed user count
activityCooldown {
  enabled: true
  // This multiplies the final cooldown in seconds
  multiplier: 1
}

selfPixelTimeIncrease: true

// Cooldown multiplier for placing on non-background pixels
backgroundPixel {
  enabled: true
  // This multiplies the final cooldown in seconds
  multiplier: 1.6
}

// System host, used for various things, including auth. MUST be set correctly or you'll have a bad time trying to debug auth. Should be set to your domain - or IP if testing locally - without port.
host: ""

captcha {
  // Captcha will show rougly 1/<threshold> times
  threshold: 5
  key: ""
  secret: ""
  maxPixels: 0
  allTime: true
}

stacking {
  cooldownMultiplier: 3,
  maxStacked: 5
}

whoamiAllowedOrigin: "https://pxls.space"

oauth {
  useIp: false
  // Should be your url + /auth (for example, http://pxls.space/auth)
  callbackBase: ""

  enableRegistration: true

  // Create at https://www.reddit.com/prefs/apps
  reddit {
    key: ""
    secret: ""
    minAge: 1d
  }

  // Create at https://console.developers.google.com/
  google {
    key: ""
    secret: ""
  }

  // Create at https://discordapp.com/developers/applications/me
  discord {
    key: ""
    secret: ""
    minAge: 1d
  }

  // Create at https://vk.com/apps?act=manage
  vk {
    key: ""
    secret: ""
  }

  // Create at https://www.tumblr.com/oauth/apps
  tumblr {
    key: ""
    secret: ""
  }
}

chat {
  filter {
    enabled: true
    static: []
    regex: ["n([i1]+)g+([e3a4])[2r]?[5sz]?", "f[a4]g+[sz5]?([o0][7t]+)?", "k[1i]+k[e3]+[5sz]?"] //"nigger, faggot, kike" and their short/1337/plural alternatives
  }
  trimInput: true
}