diff --git a/config/default.toml b/config/default.toml index 250df3f..47e966d 100644 --- a/config/default.toml +++ b/config/default.toml @@ -7,7 +7,6 @@ saltRounds = 12 name = '' domain = '' registration = false -webFormat = 'hls' restrictedNames = ['live'] rootredirect = '/users/live' @@ -41,7 +40,6 @@ ping = 30 ping_timeout = 60 [server.http] -port = 8080 allow_origin = '*' directory = './site' diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md new file mode 100644 index 0000000..4c01a44 --- /dev/null +++ b/docs/CONFIGURATION.md @@ -0,0 +1,26 @@ +## Configuring Satyr + +### Config file +All changes to satyr's config will go in the config/local.toml file +Some values you might want to change are +``` +[satyr] +registration = true +#allow new users to register +rootRedirect = '/users/live' +#the page users are directed to when they visit your site root +[media] +record = true +#allow users to record VODs +[bcrypt] +saltRounds = 12 +#change the number of rounds of bcrypt to fit your hardware +#if you don't understand the implications, don't change this +[ircd] +enable = true +#enable IRC peering +``` + +### Web Frontend +If you want to customize the front-end css, place a file with any changes you wish to make at site/local.css +You can change the logo by replacing site/logo.svg, or edit templates/base.njk to look for another source. \ No newline at end of file diff --git a/docs/INSTALLING.md b/docs/INSTALLING.md deleted file mode 100644 index d18e543..0000000 --- a/docs/INSTALLING.md +++ /dev/null @@ -1,57 +0,0 @@ -## Installing Satyr -A generic guide for install satyr. Example commands are provided for distributions based on debian and arhc. - -### Preparing the system -It is reccomended to create a system user to run satyr. -```bash -adduser satyr -D /var/lib/satyr -m -r -U -``` -Install ffmpeg and mysql with your package manager. -```bash -sudo apt install ffmpeg mysql -pacman -S ffmpeg mysql -``` - -### Installing NodeJS - -#### Installing on distributions with a compatible version of node -If your distribution ships with a compatible version of node(stable, >=10), you can install it with your distribution's package manager. -```bash -sudo apt install nodejs -``` -You can verify the version with -```bash -node --verion -``` -#### Installing on distributions with an incompatible version of node -If the version provided by your disribution is not a new enough version, is a nightly build (such as Arch), you will need to get a compatible version from [nodejs.org](https://nodejs.org/en/downloads) and add the binaries to your path. -```bash -wget https://nodejs.org/dist/path/to/download.tar.xz -tar -xf node-v10.something.tar.xz -``` -Add the /bin folder to your path (and the path of the satyr user), or symlink the binaries. -```bash -sudo ln -sf node-v10.something/bin/node /usr/bin -sudo ln -sf node-v10.something/bin/npm /usr/bin -sudo ln -sf node-v10.something/bin/npx /usr/bin -``` - -Alternatively, use a tool like [nvm](https://github.com/nvm-sh/nvm) to manage your current node version. - -### Install Satyr -Clone the satyr repo to a folder such as /opt/satyr or /var/lib/satyr and make satyr the owner of the folder. -```bash -sudo mkdir -p /opt/satyr -sudo chown -R satyr:satyr /opt/satyr -sudo -Hu satyr git clone https://gitlab.com/knotteye/satyr.git /opt/satyr -``` -Change to the satyr directory and install dependecies. It will ask you a few questions to generate an initial config. -```bash -cd /opt/satyr -npm install -``` -Build and start the server. -```bash -npm run build -npm start -``` diff --git a/docs/README.md b/docs/README.md index 3c1da83..e7427b2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,6 +7,7 @@ System dependencies: A stable version of node>=10, mysql3 (or a compatible imple git clone https://gitlab.com/knotteye/satyr.git cd satyr npm install +npm run setup npm run build ``` diff --git a/site/styles.css b/site/styles.css index 5ceb2b1..1370aa0 100644 --- a/site/styles.css +++ b/site/styles.css @@ -1,10 +1,10 @@ body { - color: white; - background-color: #1f1f1f; + color: rgb(0, 0, 0); + background-color: rgb(255, 255, 255); } a { - color: #368cf3; + color: #074115; text-decoration: none; } @@ -52,7 +52,7 @@ a { #footer { text-align: center; - color: #bdbdbd; + color: #000000; } #footer > div { diff --git a/src/http.ts b/src/http.ts index 5f07be4..a038225 100644 --- a/src/http.ts +++ b/src/http.ts @@ -13,7 +13,6 @@ function init(satyr: any){ njk.configure('templates', { autoescape: true, express : app, - watch: true }); njkconf ={ sitename: satyr.name, diff --git a/templates/user.njk b/templates/user.njk index d8a12c4..c077869 100644 --- a/templates/user.njk +++ b/templates/user.njk @@ -1,7 +1,7 @@ {% extends "base.njk" %} {% block content %}
- {{ user }} | {{ streamtitle | escape }} Links | VODs + {{ user }} | {{ streamtitle | escape }} Links | VODs