Browse Source

Fixed headers. Oops.

merge-requests/1/merge
knotteye 2 years ago
parent
commit
d1cd2815e4
  1. 13
      README
  2. 14
      docs/INSTALLING.md
  3. 8
      docs/README.md
  4. 26
      ircd-setup

13
README

@ -1,13 +0,0 @@
Satyr: A livestreaming server
System dependencies: npm, node, typescript
(Typescript can be installed through npm)
Build Instructions
git clone https://gitlab.com/knotteye/satyr.git
cd satyr
npm install
tsc
Run the server
node server.js

14
docs/INSTALLING.md

@ -1,7 +1,7 @@
##Installing Satyr
## Installing Satyr
A generic guide for install satyr. Example commands are provided for distributions based on debian and arhc.
###Preparing the system
### Preparing the system
It is reccomended to create a system user to run satyr.
```bash
adduser satyr -D /var/lib/satyr -m -r -U
@ -12,9 +12,9 @@ sudo apt install ffmpeg mysql
pacman -S ffmpeg mysql
```
###Installing NodeJS
### Installing NodeJS
####Installing on distributions with a compatible version of node
#### 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
@ -23,7 +23,7 @@ You can verify the version with
```bash
node --verion
```
####Installing on distributions with an incompatible version of node
#### 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
@ -38,7 +38,7 @@ 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
### 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
@ -54,4 +54,4 @@ Build and start the server.
```bash
npm run build
npm start
```
```

8
docs/README.md

@ -1,8 +1,8 @@
##Satyr: A livestreaming server
## Satyr: A livestreaming server
System dependencies: A stable version of node>=10, mysql3 (or a compatible implementation such as MariaDB), and ffmpeg >=4.2
###Build Instructions
### Build Instructions
```bash
git clone https://gitlab.com/knotteye/satyr.git
cd satyr
@ -10,7 +10,7 @@ npm install
npm run build
```
###Run the server
### Run the server
```bash
npm start
```
```

26
ircd-setup

@ -1,26 +0,0 @@
#!/bin/sh
mkdir -p lib
cd lib
wget https://github.com/inspircd/inspircd/archive/v3.3.0.tar.gz
tar -xvf v3.3.0.tar.gz
rm v3.3.0.tar.gz
cd inspircd-3.3.0
#./configure --enable-extras=m_pgsql.cpp --enable-extras=m_ssl_openssl.cpp
echo "no
yes
no
no
no
yes
no
no
no
no
no
no
no
no
yes
yes
no" | ./configure
make -j8 install
Loading…
Cancel
Save