Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
doihaveto authored Sep 25, 2024
1 parent 3bc7444 commit e1d1acc
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,37 @@ Features:
- Production year
- Community rating (IMDB)
- Critic rating (Rotten Tomatoes)
- Maximum runtime
- Hide played movies
- Categories:
- Today's picks (random movies, consistent across the day).
- Latest movies
- Newest movies
- Favourites
- Each available genre
- Plays movie trailers automatically (can be disabled in the settings menu).

![Screenshot](https://i.imgur.com/wwueVA6.png)

## Installation
You can either use the included docker files, or manually run it.
You can either use docker, or manually run it.

### Docker
An `API_URL` environment variable is required with the value being the address to your Jellyfin server, including trailing slash (`http://localhost:5000/`, for example).
An example docker-compose file:
```
version: '3.9'
services:
jellix:
image: ghcr.io/doihaveto/jellix
container_name: jellix
build: ./jellix
restart: unless-stopped
environment:
- API_URL=http://localhost:5000/
ports:
- 3000:3000
- 3000:80
```

This will run Jellix on port 3000, which you can either access directly or preferably use in nginx.
This will run Jellix on port 3000.

### Manual
This project is composed entirely of static files. All that it requires is a web server. First, edit `code/params.js` to your Jellyfin server, including trailing slash (`http://localhost:5000/`, for example). After that you can either deliver this project as a static directory via nginx or some other web server, or you can spin one your own with python by running `python -m http.server 3000` in the `code` directory, which you can then access via http://localhost:3000/

0 comments on commit e1d1acc

Please sign in to comment.