Fix Grammar

Fix Grammar and some minor details
This commit is contained in:
felix920506 2023-05-19 01:14:23 +08:00
parent abd2e41a3b
commit 451ab01e0c

View File

@ -8,53 +8,53 @@ title: Windows
## Required Tools and Resources
* A Windows 10/11 PC
* A User Account with Admin Privileges
* An Internet Connection
* A Public IP Address
* A Text Editor (Notepad will work but [Notepad++](https://notepad-plus-plus.org/downloads/) or [VSCode](https://code.visualstudio.com/Download) is recommended)
* A Browser that isn't internet explorer
* A user account with admin privileges
* An internet connection
* A public IP address
* A text editor (Notepad will work but [Notepad++](https://notepad-plus-plus.org/downloads/) or [VSCode](https://code.visualstudio.com/Download) is recommended)
* A browser that isn't Internet Explorer
## Before you begin
* Connect your PC with Ethernet instead of Wifi
* Set PC to never go to sleep automatically ([Guide](https://support.microsoft.com/en-us/windows/how-to-adjust-power-and-sleep-settings-in-windows-26f623b5-4fcc-4194-863d-b824e5ea7679))
* Show file extensions in explorer ([Guide](https://www.howtogeek.com/205086/beginner-how-to-make-windows-show-file-extensions/))
* Setup Auto login for your user account if you haven't already ([Guide](https://www.lifewire.com/how-do-i-auto-login-to-windows-2626066))
* Make your media file accessible on this computer by this user
* Connect your PC with ethernet instead of Wi-Fi
* Set your PC to never go to sleep automatically ([Guide](https://support.microsoft.com/en-us/windows/how-to-adjust-power-and-sleep-settings-in-windows-26f623b5-4fcc-4194-863d-b824e5ea7679))
* Show file extensions in Explorer ([Guide](https://www.howtogeek.com/205086/beginner-how-to-make-windows-show-file-extensions/))
* Setup auto login for your user account if you haven't already ([Guide](https://www.lifewire.com/how-do-i-auto-login-to-windows-2626066))
* Make your media files accessible on this computer by this user
* Install latest updates ([Guide](https://support.microsoft.com/en-us/windows/get-the-latest-windows-update-7d20e88c-0568-483a-37bc-c3885390d212))
* Setup Remote Access (Optional). Popular options include [Teamviewer](https://www.teamviewer.com/), [AnyDesk](https://anydesk.com/), [RustDesk](https://rustdesk.com/), [Google Remote Desktop](https://remotedesktop.google.com/) and [Parsec](https://parsec.app/)
* Setup remote access (optional). Popular options include [Teamviewer](https://www.teamviewer.com/), [AnyDesk](https://anydesk.com/), [RustDesk](https://rustdesk.com/), [Google Remote Desktop](https://remotedesktop.google.com/) and [Parsec](https://parsec.app/)
## Notes
* How to open a Terminal from current location in explorer
* How to open a Terminal from current location in Explorer
* Windows 10
* Right Click on blank space while holding down `Shift`
* Right click on blank space while holding down `Shift`
* Click `Open PowerShell window here`
* Windows 11
* Right Click on blank space
* Right click on blank space
* Click `Open in Windows Terminal` or `Open in Terminal`
## Jellyfin Install
### Install
1. Download Installer exe and sha256sum from [the official repo](https://repo.jellyfin.org/releases/server/windows/stable/). The files to download are `installer/jellyfin_x.y.z_windows-x64.exe` and `installer/jellyfin_x.y.z_windows-x64.exe`.
1. Download installer exe and sha256sum from [the official repo](https://repo.jellyfin.org/releases/server/windows/stable/). The files to download are `installer/jellyfin_x.y.z_windows-x64.exe` and `installer/jellyfin_x.y.z_windows-x64.exe`.
![Windows Download Page](/images/docs/quick-start/windows/jellyfin-0.png)
2. Once download finishes, open the sha256sum in a text editor
3. Open a Terminal in your Downloads folder and enter this command: `certutil -hashfile .\jellyfin_x.y.z_windows-x64.exe SHA256`, replace `jellyfin_x.y.z_windows-x64.exe` with the executable you just downloaded.
4. Wait for command to finish and see if it matches the value in the sha256sum file. If the values don't match, at least one of the files is corrupted and both files should be redownloaded.
2. Once the download finishes, open the sha256sum in a text editor
3. Open a Terminal in your Downloads folder and enter this command: `certutil -hashfile .\jellyfin_x.y.z_windows-x64.exe SHA256`, replace `jellyfin_x.y.z_windows-x64.exe` with the .exe file you just downloaded.
4. Wait for the command to finish and see if it matches the value in the sha256sum file. If the values don't match, at least one of the files is corrupted and both files should be redownloaded.
![Checksum Match](/images/docs/quick-start/windows/jellyfin-1.png)
Values Match, files are good
Values match, files are good
![Checksum Doesn't Match](/images/docs/quick-start/windows/jellyfin-2.png)
Values don't match, possibly corrupted file(s)
5. Run and follow the Installer
5. Run and follow the installer
6. Look for a Jellyfin icon in your system tray. If it isn't present, search for `Jellyfin Tray App` and run it. No windows will popup after running this application.
![Jellyfin Tray App Search](/images/docs/quick-start/windows/jellyfin-3.png)
@ -71,40 +71,40 @@ title: Windows
### Hardware Accel
See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/hardware-acceleration/)
See [Hardware Acceleration](/docs/general/administration/hardware-acceleration/)
## Reverse Proxy
### Router Settings
1. Press Win + R, enter `control` and click OK to open Control Panel
1. Press `Win + R`, enter `control` and click `OK` to open Control Panel
![Run Control](/images/docs/quick-start/windows/router-1.png)
2. Navigate to `Network and Internet > Network and Sharing Center`
3. Click on the internet connection under Connections
3. Click on the `Internet Connection` under `Connections`
![Ethernet Connection](/images/docs/quick-start/windows/router-2.png)
4. Click `Details` in the popup and note the `IPv4 Address` and `IPv4 Default Gateway` values. The `IPv4 Address` is the LAN IP address of your Jellyfin server and the `IPv4 Default Gateway` is usually your Router.
4. Click `Details` in the popup and note down the `IPv4 Address` and `IPv4 Default Gateway` values. The `IPv4 Address` is the LAN IP address of your Jellyfin server and the `IPv4 Default Gateway` is usually your Router.
![Network Connection Details](/images/docs/quick-start/windows/router-3.png)
5. go to [https://ipv4.icanhazip.com](https://ipv4.icanhazip.com) and note the IP address
5. go to [https://ipv4.icanhazip.com](https://ipv4.icanhazip.com) and note down the IP address
6. Go to the `IPv4 Default Gateway` IP in a browser (for this example, `http://192.168.50.1/`) and Login to your router. If you do not have the credentials, look for them on the bottom of your router or online with the model number of your router
7. Most Routers will show a WAN IP in the index. Check if the IP matches the IP you noted down in step 5. If it doesn't, you do not have a routable IP address. In this case, you should stop following this guide and look for other options for remote access.
7. Most Routers will show a WAN IP in the index. Check if the WAN IP matches the IP you noted down in step 5. If it doesn't, you do not have a routable IP address. In this case, you should stop following this guide and look for other options for remote access.
![ASUS router settings page](/images/docs/quick-start/windows/router-4.png)
ASUS Router Settings Page
8. Assign your Jellyfin Host Permanent local IP. The option is usually under LAN and named DHCP Server or DHCP. If you assign a different IP than what it currently has, you may need to reconnect the internet of this PC for settings to apply properly. In this case, I am assigning 192.168.50.142 to my PC.
8. Assign your Jellyfin host a static local IP. The option is usually under `LAN` and named `DHCP Server` or `DHCP`. If you assign a different IP than what it currently has, you may need to reconnect the internet of this PC for settings to apply properly. In this case, I am assigning 192.168.50.142 to my PC.
![Static DHCP](/images/docs/quick-start/windows/router-5.png)
9. Find Port Forwarding Settings in your Router. This setting is usually under WAN, Firewall, Security or NAT and usually named Port Forwarding or Virtual Server. Port Trigger is NOT the setting you are looking for
9. Find `Port Forwarding` settings in your router. This setting is usually under `WAN`, `Firewall`, `Security` or `NAT`and usually named `Port Forwarding` or `Virtual Server`. `Port Trigger` is NOT the setting you are looking for.
10. Forward ports 80 and 443 to the IP you assigned previously
@ -112,16 +112,16 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
### Install Caddy
1. go to the [official Caddy server download page](https://caddyserver.com/download)
2. Choose `Windows amd64` for the platform and click download. leave the standard features checkbox checked. You do NOT need any extra features.
1. Go to the [official Caddy server download page](https://caddyserver.com/download)
2. Choose `Windows amd64` for the platform and click download. Leave the standard features checkbox checked. You do NOT need any extra features.
![Caddy Download](/images/docs/quick-start/windows/caddyinst-1.png)
3. Create a new folder under C:\ and name it caddy
3. Create a new folder under `C:\` and name it `caddy`
![Create Caddy folder](/images/docs/quick-start/windows/caddyinst-2.png)
4. move the downloaded exe file to the folder and rename it to caddy.exe
4. move the downloaded exe file to the folder and rename it to `caddy.exe`
![Place Caddy exe](/images/docs/quick-start/windows/caddyinst-3.png)
@ -129,7 +129,7 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
![This PC Right Click Menu](/images/docs/quick-start/windows/caddyinst-4.png)
6. Click `Advanced system settings`. it will be after Device Specifications on Windows 11, or in the left sidebar on Windows 10
6. Click `Advanced System Settings`. it will be after `Device Specifications` on Windows 11, or in the left sidebar on Windows 10
7. Click on `Environment Variables` in the popup and doubleclick on `Path` under the `User variables for user` in the second popup
![Environment Variables](/images/docs/quick-start/windows/caddyinst-5.png)
@ -138,8 +138,8 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
![New PATH value](/images/docs/quick-start/windows/caddyinst-6.png)
9. Click on OK for the other 2 popups to save and apply settings
10. reboot to make sure settings apply poperly
9. Click on `OK` for the other 2 popups to save and apply settings
10. Reboot to make sure settings apply poperly
### Test if http is routable
@ -169,8 +169,8 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
![duckdns dashboard](/images/docs/quick-start/windows/ddns-1.png)
3. Download the latest Windows C# client zip from [its Github Releases page](https://github.com/XWolfOverride/DuckDNS/releases)
4. create a new subfolder under C:\ and name it `duckdns`
3. Download the latest Windows C# client zip from [its Github releases page](https://github.com/XWolfOverride/DuckDNS/releases)
4. Create a new subfolder under `C:\` and name it `duckdns`
![duckdns folder](/images/docs/quick-start/windows/ddns-2.png)
@ -179,17 +179,17 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
![duckdns exe](/images/docs/quick-start/windows/ddns-3.png)
6. Run `DuckDNS.exe`
7. Enter the Domain you just created and the Token from your DuckDNS dashboard, change interval to 5m and click on OK
7. Enter the Domain you just created and the Token from your DuckDNS dashboard, change interval to `5m` and click on `OK`
![duckdns client interface](/images/docs/quick-start/windows/ddns-4.png)
8. Make sure that no errors appeared and there is a yellow duck in your system tray. If the duck is red, check your configuration.
9. hit Win + R, enter `taskschd.msc` and click OK or click enter
9. hit `Win + R`, enter `taskschd.msc` and click `OK`
![run task scheduler](/images/docs/quick-start/windows/ddns-5.png)
10. Click on Create basic task on the right panel.
10. Click on `Create basic task` on the right panel.
11. Enter a descriptive Name and a description, one that you can identify in the future and click next
12. Choose `When I log on` for the Task Trigger and click Next
13. Choose `Start a program` for the Action
@ -197,23 +197,23 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
![create duckdns task](/images/docs/quick-start/windows/ddns-6.png)
15. Check Open the Properties dialog checkbox and click Finish
15. Check `Open the Properties dialog` checkbox and click `Finish`
![finish wizard](/images/docs/quick-start/windows/ddns-7.png)
16. Go to the Settings Pane in the dialog and uncheck the `Stop the task if it runs longer than` checkbox, then click OK
16. Go to the `Settings` Pane in the dialog and uncheck the `Stop the task if it runs longer than` checkbox, then click `OK`
![duckdns task properties](/images/docs/quick-start/windows/ddns-8.png)
### Reverse Proxy with Caddy
1. Go to your caddy folder (the one you created in the Install Caddy section which should be `C:\caddy`)
2. create a text file named `CaddyFile` (Remove the .txt suffix). You will be asked to confirm if you want to change the file extension, click Yes.
2. create a text file named `CaddyFile` (Remove the .txt suffix). You will be asked to confirm if you want to change the file extension, click `Yes`.
![file extension change confirmation](/images/docs/quick-start/windows/reverseproxy-1.png)
3. Open the file in a text editor and paste in config from below depending on your needs. Replace `<your (sub)domain here>` with the domain you just created with DuckDNS.
* if you want your jellyfin instance behind the bare domain / subdomain(example.com / jellyfin.example.com):
* if you want your jellyfin instance behind the bare domain (subdomain.example.com / jellyfin.example.com):
```Caddyfile
<your (sub)domain here>
@ -231,17 +231,17 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
```
4. save the file and close the text editor
5. If you have chosen to use a subpath for jellyfin, go to your jellyfin dashboard (open [http://localhost:8096](http://localhost:8096) on your server, click the 3 bars on the top right then select Dashboard) and go to the Networking menu on the side bar. Then enter the subpath you have chosen to use and save. Then restart the Jellyfin server (Stop then start the server from the system tray icon)
5. If you have chosen to use a subpath for Jellyfin, go to your Jellyfin dashboard (open [http://localhost:8096](http://localhost:8096) on your server, click the 3 bars on the top right then select `Dashboard`) and go to the `Networking` menu on the side bar. Then enter the subpath you have chosen to use and save. Then restart the Jellyfin server (Stop then start the server from the system tray icon)
![Networking Settings](/images/docs/quick-start/windows/reverseproxy-2.png)
6. open a terminal in the caddy folder and run `caddy start`. If there are no errors, you can safely close the terminal.
7. go to `http://<your (sub)domain here>` or `http://<your (sub)domain here>/jellyfin` in a browser to test if it is working. You should be able to see a Jellyfin Login Page.
8. hit Win + R, enter `taskschd.msc` and click OK
6. open a terminal in the caddy folder and run `caddy run`. If there are errors, check your configs and try again. Keep this window running.
7. go to `http://<your (sub)domain here>` or `http://<your (sub)domain here>/jellyfin` in a browser to test if it is working. You should be able to see the Jellyfin Login Page.
8. hit `Win + R`, enter `taskschd.msc` and click `OK`
![run taskschd](/images/docs/quick-start/windows/reverseproxy-3.png)
9. Click on Create basic task on the right panel.
9. Click on `Create basic task` on the right panel.
10. Enter a descriptive Name and a description, one that you can identify in the future and click next
11. Choose `When I log on` for the Task Trigger and click Next
12. Choose `Start a program` for the Action
@ -254,7 +254,7 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
![caddy task propeties](/images/docs/quick-start/windows/reverseproxy-5.png)
16. Reboot to test configuration. There will be a Terminal window open after bootup. This is normal.
16. Reboot to test configuration. There will be a Terminal window open after bootup. This is normal. Keep this window open.
![running caddy terminal](/images/docs/quick-start/windows/reverseproxy-6.png)