Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switching headers from atx_closed to atx #1130

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Switching headers from atx_closed to atx #1130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/general/clients/jellyfin-vue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ If you identify with at least one of the following options:
You're probably better using [our hosted instance](https://jf-vue.pages.dev).
More info at [Jellyfin Vue's repository](https://github.com/jellyfin/jellyfin-vue).

# Deployment #
# Deployment

:::caution
Since Jellyfin Vue is just an interface for a Jellyfin server, all of these instructions assume that you already have a server up and running.
[Set it up now](../installation/index.mdx) if you haven't already.
:::

## RECOMMENDED: Using Docker ##
## RECOMMENDED: Using Docker

* In case you don't have Docker, follow [the official installation guide](https://docs.docker.com/engine/install) first.
Learning about [Compose](https://docs.docker.com/compose) is also recommended.
Expand Down Expand Up @@ -94,7 +94,7 @@ You can learn more about how the connection to your server works
[in Jellyfin's Vue repository privacy disclaimer](https://github.com/jellyfin/jellyfin-vue#privacy-disclaimer-)
:::

### Using environment variables ###
### Using environment variables

This is an example of how environment variables are set in the container by adding the
following keys to the `jellyfin_vue` definition in [the above `docker-compose.yml`](#recommended-using-docker):
Expand All @@ -107,7 +107,7 @@ environment:
See the [complete reference of environment variables available](https://github.com/jellyfin/jellyfin-vue/wiki/Configuration)
to further customize Jellyfin Vue to your liking at Jellyfin Vue's wiki.

### Using your own webserver ###
### Using your own webserver

Since Jellyfin Vue is an SPA web application, you can use any web server to serve it:
Apache, nginx (the one used in Jellyfin's Vue docker image), Traefik, etc...
Expand Down Expand Up @@ -139,22 +139,22 @@ This approach:
* In case you use [environment variables](#using-environment-variables),
they will still be applied.

## Manually ##
## Manually

:::caution
Make sure you understand [the implications](#why-updates-needed) before using these methods first.
None of them are supported by Jellyfin Vue.
:::

### `docker run` ###
### `docker run`

In case you don't want to use Docker Compose or automated updates, but still use Docker, this command is enough:

```bash
docker run -d -p 8080:80 ghcr.io/jellyfin/jellyfin-vue:unstable
```

### From source / build output ###
### From source / build output

:::info
This might not be necessary if you just want to test a Pull Request.
Expand All @@ -177,7 +177,7 @@ has instructions for setting up the development environment.
* All artifacts generated by GitHub Actions are [built with provenances](https://github.com/jellyfin/jellyfin-vue/attestations).
* Our official Docker image is built from GitHub Actions and all the process is transparent and can be audited.

## Other documentation ##
## Other documentation

* The rest of the documentation about Jellyfin Vue can be found on it's [wiki](https://github.com/jellyfin/jellyfin-vue/wiki).

Expand Down