3 Config

dicedtomato edited this page 2020-08-15 10:48:36 -07:00

Table of Contents

• Uploader Configuration (uploader.*)
• Shortener Configuration (shortener.*)
• Notes Configuration (notes.*)
• Database Configuration (database.*)
• Core Configuration (core.*)
• Core SSL Configuration (core.ssl.*)
• Core Ports Configuration (core.port.*)
• Meta Configuration (meta.*)
• Discord Webhook Configuration (discordWebhook.*)
• Discord Webhook Events Configuration (discordWebhook.events.*)

Uploader Configuration (uploader.*)

Property	Description	Example
length: number	How long the randomly generated names should be	6
temp: string	Where temporary files are stored	./temp
upload: string	Where uploads are stored	./uploads
route: string	Where uploads are served	/u or /images, etc
blacklistedExt: string[]	An array of blacklisted extentions	["jpeg", "avi"]

Shortener Configuration (shortener.*)

Property	Description	Example
length: number	How long the randomly generated names should be	4
route: string	Where uploads are served	/s or /url, etc

Notes Configuration (notes.*)

Property	Description	Example
length: number	How long the randomly generated names should be	4
route: string	Where uploads are served	/n or /note, etc

Database Configuration (database.*)

Go here to learn how to format your database configuration, or you can take a look at the example config page and mess around with that.

Core Configuration (core.*)

Property	Description	Example
secure: boolean	If the server is HTTP or HTTPS (secure)	false
log: boolean	Logs when routes are accessed, like / or /api/upload	true
adminPassword: string	The administrators password, used to create accounts and more!	false
sessionSecret: string	The session secret, for storing users in a browser session, this can literally be anything.	asdfghjkl
saltRounds: string	How many salt rounds needed for encrypting passwords	10
userTokenLength: number	How long the randomly generated auth tokens are	34
ssl: Core SSL	See Core SSL Configuration
port: Core Ports	See Core Port Configuration

Core SSL Configuration (core.ssl.*)

Property	Description	Example
key: string	The SSL server key	./ssl/server.key
cert: string	The SSL certificate	./ssl/server.crt

Core Ports Configuration (core.port.*)

Property	Description	Example
secure: number	What port the server should run on when in secure mode	433
unsecure: number	What port the server should run on when in unsecure mode	8080

Meta Configuration (meta.*)

Property	Description	Example
favicon: string	A URL for the favicon	/public/assets/my_custom_image.png or https://some-thing-here.com/image/cat.png
title: string	The title that will appear on browsers, like <title> - Login	Zipline

Discord Webhook Configuration (discordWebhook.*)

Property	Description	Example
enabled: boolean	Whether or not events should be
url: string	The webhook URL	https://canary.discord.com/api/webhooks/??/??
username: string	The username of the webhook, can be anything you would like.	Zipline Logs
avatarURL: string	The avatar of the webhook, can be anything you would like.	https://some-thing-here.com/image/cat.png
events: Webhook Events	See Discord Webhook Events Configuration

Discord Webhook Events Configuration (discordWebhook.events.*)

This feature is coming soon, for formatting messages see this

Property	Description	Example
onUpload: string	A message to send when a new file is uploaded	``
onShorten: string	A message to send when a new URL is shortened	``
onNote: string	A message to send when a new note is created	``
onLogin: string	A message to send when a user has logged in	``
onUserEdit: string	A message to send when a user edits their account	``
onUserReset: string	A message to send when a user resets their password	``
onUserTokenReset: string	A message to send when a user resets their token	``
onUserDelete: string	A message to send when a users account is deleted	``
onUserEdit: string	A message to send when a user edits their account	``

New look, same taste