Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit 77f4aac

Browse files
authored
Add Windows installer docs and macOS app docs. (#136)
* Added Windows installer instructions. * Cleaned piece on portable binaries and added macOS stuff. * Added legacy script install back in. * Extra Installation edits. * Spelling mistakes.
1 parent 271b9d7 commit 77f4aac

File tree

1 file changed

+72
-22
lines changed

1 file changed

+72
-22
lines changed

general/administration/installing.md

Lines changed: 72 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -63,27 +63,43 @@ An Unraid Docker template is available in the repository.
6363

6464
A community project to deploy Jellyfin on Kubernetes-based platforms exists [at their repository](https://github.com/home-cluster/jellyfin-openshift). Any issues or feature requests related to deployment on Kubernetes-based platforms should be filed there.
6565

66-
## Portable Binaries
66+
## Windows (x86/x64)
6767

68-
Portable binary packages containing a compiled Jellyfin instance are available for multiple platforms. For all portable binaries, extract the relevant archive to a directory and launch the binary (`jellyfin` on Linux/MacOS, `jellyfin.exe` on Windows).
68+
Windows installers and builds in ZIP archive format are available [here](https://repo.jellyfin.org/releases/server/windows).
6969

70-
### Windows (x64/x86)
70+
[!WARNING]
71+
> If you installed a version prior to 10.4.0 using a PowerShell script, you will need to manually remove the service using the command `nssm remove Jellyfin` and uninstall the server by remove all the files manually. Also one might need to move the data files to the correct location, or point the installer at the old location.
7172
72-
Windows builds in ZIP archive format are available [here](https://repo.jellyfin.org/releases/server/windows).
73+
[!WARNING]
74+
> The 32-bit or x86 version is not recommended. `ffmpeg` and its video encoders generally perform better as a 64-bit executable due to the extra registers provided. This means that the 32-bit version of Jellyfin is deprecated.
7375
74-
### Install via script
76+
### Install using installer (x64)
77+
78+
Only available for versions 10.4.0+.
79+
80+
**Install**
81+
82+
1. Download the latest version
83+
1. Run the installer
84+
1. (optional) When installing as a service, pick the service account type.
85+
1. If everything was completed successfully, the Jellyfin service is now running
86+
1. Open your browser at http://localhost:8096 to finish setting up Jellyfin
87+
88+
89+
**Update**
90+
1. Download the latest version
91+
1. Run the installer
92+
1. If everything was completed successfully, the Jellyfin service is now running as the new version.
93+
94+
95+
**Uninstall**
96+
97+
1. Go to `Add or remove programs` in Windows
98+
1. Search for Jellyfin
99+
1. Click Uninstall
75100

76-
1. Download and extract the latest version
77-
1. Run `install.bat` or `install-jellyfin.ps1`
78-
1. (optional) Enter a custom install location (default is `%appdata%`)
79-
1. (optional) Enter a custom library/data location (default is `%localappdata%`) - Currently not working
80-
1. (optional) Select to install jellyfin as a service
81-
1. (optional) Import old library - Not compatible with newer Emby versions
82-
1. (optional) Create a shortcut on your desktop
83-
1. (optional) Run Jellyfin after installation
84-
1. Press `Install`
85101

86-
### Manual installation
102+
### Manual installation (x86/x64)
87103

88104
**Install**
89105

@@ -93,12 +109,12 @@ Windows builds in ZIP archive format are available [here](https://repo.jellyfin.
93109
1. Create `jellyfin.bat` within your `jellyfin` folder containing:
94110
- To use the default library/data location at `%localappdata%`:
95111
`<--Your install path-->\jellyfin\system\jellyfin.exe`
96-
- To use a custom library/data location (Path after the -d paramenter):
112+
- To use a custom library/data location (Path after the -d parameter):
97113
`<--Your install path-->\jellyfin\system\jellyfin.exe -d <--Your install path-->\jellyfin\data`
98-
- To use a custom library/data location (Path after the -d paramenter) and disable the autostart of the webapp:
114+
- To use a custom library/data location (Path after the -d parameter) and disable the auto-start of the webapp:
99115
`<--Your install path-->\jellyfin\system\jellyfin.exe -d <--Your install path-->\jellyfin\data -noautorunwebapp`
100116
1. Run `jellyfin.bat`
101-
1. Open your browser at http://<--Server-IP-->:8096 (if autostart of webapp is disabled)
117+
1. Open your browser at http://<--Server-IP-->:8096 (if auto-start of webapp is disabled)
102118

103119

104120
**Update**
@@ -116,15 +132,49 @@ Windows builds in ZIP archive format are available [here](https://repo.jellyfin.
116132
1. Rename `system-bak` to `system`
117133
1. Run `jellyfin.bat` to start the server again
118134

119-
### MacOS
135+
### Install using legacy script (x86/x64)
136+
137+
Only for versions 10.3.x and earlier.
138+
139+
1. Download and extract the latest version
140+
1. Run `install.bat` or `install-jellyfin.ps1`
141+
1. (optional) Enter a custom install location (default is `%appdata%`)
142+
1. (optional) Enter a custom library/data location (default is `%localappdata%`) - Currently not working
143+
1. (optional) Select to install Jellyfin as a service
144+
1. (optional) Import old library - Not compatible with newer Emby versions
145+
1. (optional) Create a shortcut on your desktop
146+
1. (optional) Run Jellyfin after installation
147+
1. Press `Install`
148+
149+
## MacOS
150+
151+
MacOS Application packages and builds in TAR archive format are available [here](https://repo.jellyfin.org/releases/server/macos).
152+
153+
**Install**
154+
155+
1. Download the latest version.
156+
1. Drag the `.app` package into the Applications folder
157+
1. Start the application
158+
1. Open your browser at http://localhost:8096
159+
160+
**Upgrade**
161+
162+
1. Download the latest version.
163+
1. Stop the currently running server either via the dashboard or using the application icon.
164+
1. Drag the new `.app` package into the Applications folder and click yes to replace the files.
165+
1. Start the application
166+
1. Open your browser at http://localhost:8096
167+
168+
**Uninstall**
120169

121-
MacOS builds in TAR archive format are available [here](https://repo.jellyfin.org/releases/server/macos).
170+
1. Stop the currently running server either via the dashboard or using the application icon.
171+
1. Move the `.app` package to the Trash.
122172

123-
### Linux (generic amd64)
173+
## Linux (generic amd64)
124174

125175
Generic amd64 Linux builds in TAR archive format are available [here](https://repo.jellyfin.org/releases/server/linux).
126176

127-
### Portable DLL
177+
## Portable DLL
128178

129179
Platform-agnostic .NET Core DLL builds in TAR archive format are available [here](https://repo.jellyfin.org/releases/server/portable). These builds use the binary `jellyfin.dll` and must be loaded with `dotnet`.
130180

0 commit comments

Comments
 (0)