PrivateCoffee/invidious
4
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

Rewrite installation guide

Browse source
This commit is contained in:
Perflyst 2019-01-23 21:12:02 +01:00 committed by GitHub
parent 5e272db8f5
commit 03aa11b412
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 57 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
README.md
View file

@ -57,63 +57,84 @@ $ docker volume rm invidious_postgresdata
$ docker-compose build $ docker-compose build
``` ```
### Arch Linux: ### Linux:
#### Install dependencies
```bash ```bash
# Install dependencies # Arch Linux
$ sudo pacman -S shards crystal imagemagick librsvg $ sudo pacman -S shards crystal imagemagick librsvg postgresql
# Setup PostgresSQL # Ubuntu or Debian
$ sudo systemctl enable postgresql
$ sudo systemctl start postgresql
$ sudo -i -u postgres
$ createuser -s YOUR_USER_NAME
$ createdb YOUR_USER_NAME
$ exit
# Setup Invidious
$ git clone https://github.com/omarroth/invidious
$ cd invidious
$ ./setup.sh
$ shards
$ crystal build src/invidious.cr --release
```
### On Ubuntu:
```bash
# Install dependencies
$ curl -sSL https://dist.crystal-lang.org/apt/setup.sh | sudo bash $ curl -sSL https://dist.crystal-lang.org/apt/setup.sh | sudo bash
$ sudo apt update $ sudo apt update
$ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev librsvg2-dev postgresql imagemagick libsqlite3-dev $ sudo apt install crystal libssl-dev libxml2-dev libyaml-dev libgmp-dev libreadline-dev librsvg2-dev postgresql imagemagick libsqlite3-dev
```
# Setup PostgreSQL #### Add invidious user and clone repository
```bash
$ useradd -m invidious
$ sudo -i -u invidious
$ git clone https://github.com/omarroth/invidious
$ exit
```
#### Setup PostgresSQL
```bash
$ sudo systemctl enable postgresql $ sudo systemctl enable postgresql
$ sudo systemctl start postgresql $ sudo systemctl start postgresql
$ sudo -i -u postgres $ sudo -i -u postgres
$ createuser -s YOUR_USER_NAME_HERE $ psql -c "CREATE USER kemal WITH PASSWORD 'kemal';"
$ createdb YOUR_USER_NAME_HERE $ createdb -O kemal invidious
$ psql invidious < /home/invidious/invidious/config/sql/channels.sql
$ psql invidious < /home/invidious/invidious/config/sql/videos.sql
$ psql invidious < /home/invidious/invidious/config/sql/channel_videos.sql
$ psql invidious < /home/invidious/invidious/config/sql/users.sql
$ psql invidious < /home/invidious/invidious/config/sql/nonces.sql
$ exit $ exit
# Setup Invidious
$ git clone https://github.com/omarroth/invidious
$ cd invidious
$ ./setup.sh
$ shards
$ crystal build src/invidious.cr --release
``` ```
### On OSX: #### Setup Invidious
```bash
$ sudo -i -u invidious
$ cd invidious
$ shards
$ crystal build src/invidious.cr --release
# test compiled binary
$ ./invidious # stop with ctrl c
$ exit
```
#### systemd service
```bash
$ sudo cp invidious.service /etc/systemd/system/invidious.service
$ sudo systemctl enable invidious.service
$ sudo systemctl start invidious.service
```
### OSX:
```bash ```bash
# Install dependencies # Install dependencies
$ brew update $ brew update
$ brew install shards crystal-lang postgres imagemagick librsvg $ brew install shards crystal-lang postgres imagemagick librsvg
# Setup Invidious # Clone repository and setup postgres database
$ git clone https://github.com/omarroth/invidious $ git clone https://github.com/omarroth/invidious
$ cd invidious $ cd invidious
$ ./setup.sh $ brew services start postgresql
$ psql -c "CREATE ROLE kemal WITH LOGIN PASSWORD 'kemal';"
$ createdb invidious -U kemal
$ psql invidious < config/sql/channels.sql
$ psql invidious < config/sql/videos.sql
$ psql invidious < config/sql/channel_videos.sql
$ psql invidious < config/sql/users.sql
$ psql invidious < config/sql/nonces.sql
# Setup Invidious
$ shards $ shards
$ crystal build src/invidious.cr --release $ crystal build src/invidious.cr --release
``` ```
@ -121,7 +142,6 @@ $ crystal build src/invidious.cr --release
## Usage: ## Usage:
```bash ```bash
$ crystal build src/invidious.cr --release
$ ./invidious -h $ ./invidious -h
Usage: invidious [arguments] Usage: invidious [arguments]
-b HOST, --bind HOST Host to bind (defaults to 0.0.0.0) -b HOST, --bind HOST Host to bind (defaults to 0.0.0.0)
@ -147,16 +167,6 @@ $ curl -fsSLo- https://raw.githubusercontent.com/samueleaton/sentry/master/insta
$ ./sentry $ ./sentry
``` ```
## Optional
Create a systemd service to run Invidious in background. Edit `invidious.service` to change your installation path and log location. Than copy and enable the systemd service.
```
$ sudo cp invidious.service /etc/systemd/system/invidious.service
$ sudo systemctl enable invidious.service
$ sudo systemctl start invidious.service
```
## Extensions ## Extensions
- [Alternate Tube Redirector](https://addons.mozilla.org/en-US/firefox/addon/alternate-tube-redirector/): Automatically open Youtube Videos on alternate sites like Invidious or Hooktube. - [Alternate Tube Redirector](https://addons.mozilla.org/en-US/firefox/addon/alternate-tube-redirector/): Automatically open Youtube Videos on alternate sites like Invidious or Hooktube.