iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2025-01-03 11:30:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add note about lsquic and add guide for windows

Browse Source
This commit is contained in:
Émilien Devos 2022-07-29 09:40:35 +00:00 committed by GitHub
parent 962431d75a
commit aa50a7734f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/installation.md
View File

@ -165,6 +165,12 @@ crystal build src/invidious.cr --release
exit
```
Note: If the command `crystal build` didn't work properly, you can build Invidious without lsquic may solve compatibilities issues:
```bash
crystal build src/invidious.cr -Ddisable_quic --release
```
#### Systemd service
```bash
@ -174,14 +180,16 @@ systemctl enable --now invidious.service
### MacOS
#### Install the dependencies
```bash
# Install dependencies
brew update
brew install shards crystal postgres imagemagick librsvg
```
# Clone the repository and set up a PostgreSQL database
git clone https://github.com/iv-org/invidious
cd invidious
#### Set up PostgresSQL
```bash
brew services start postgresql
psql -c "CREATE ROLE kemal WITH PASSWORD 'kemal';" # Change 'kemal' here to a stronger password, and update `password` in config/config.yml
createdb -O kemal invidious
@ -195,11 +203,30 @@ psql invidious kemal < config/sql/annotations.sql
psql invidious kemal < config/sql/privacy.sql
psql invidious kemal < config/sql/playlists.sql
psql invidious kemal < config/sql/playlist_videos.sql
# Set up Invidious
shards update && shards install && crystal build src/invidious.cr --release
```
#### Set up Invidious
```bash
git clone https://github.com/iv-org/invidious
cd invidious
shards install --production
crystal build src/invidious.cr --release
```
Note: If the command `crystal build` didn't work properly, you can build Invidious without lsquic may solve compatibilities issues:
```bash
crystal build src/invidious.cr -Ddisable_quic --release
```
### Windows
Crystal, the programming language used by Invidious, [doesn't support Windows yet](https://github.com/crystal-lang/crystal/issues/5430) but you can still install Invidious through two kinds of ways:
- By installing [Docker desktop](https://docs.docker.com/desktop/install/windows-install/) and then following [our guide about Docker](#docker).
- By installing [Windows Subsystem for Linux](https://msdn.microsoft.com/en-us/commandline/wsl/about) and then following [our guide about Linux](#linux).
## Post-install configuration:
Detailed configuration available in the [configuration guide](./configuration.md).