Revert quick-start -> quickstart

change back quickstart to quick-start
This commit is contained in:
felix920506 2023-05-17 23:13:51 +08:00
parent 3eb3fabe2f
commit 76f43c9b77
37 changed files with 36 additions and 36 deletions

View File

@ -1,5 +1,5 @@
---
uid: quickstart-index
uid: quick-start-index
title: Quick Start
---

View File

@ -1,5 +1,5 @@
---
uid: quickstart-windows
uid: quick-start-windows
title: Windows
---
@ -40,30 +40,30 @@ title: Windows
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/quickstart/windows/jellyfin-0.png)
![Windows Download Page](/images/docs/quick-start/windows/jellyfin-0.png)
3. Once download finishes, open the sha256sum in a text editor
4. 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.
5. 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.
![Checksum Match](/images/docs/quickstart/windows/jellyfin-1.png)
![Checksum Match](/images/docs/quick-start/windows/jellyfin-1.png)
Values Match, files are good
![Checksum Doesn't Match](/images/docs/quickstart/windows/jellyfin-2.png)
![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
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/quickstart/windows/jellyfin-3.png)
![Jellyfin Tray App Search](/images/docs/quick-start/windows/jellyfin-3.png)
Jellyfin Tray App
7. Allow Firewall Access when Prompted
![Windows Firewall Prompt](/images/docs/quickstart/windows/jellyfin-4.png)
![Windows Firewall Prompt](/images/docs/quick-start/windows/jellyfin-4.png)
Windows Firewall Prompt
@ -79,16 +79,16 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
1. Press Win + R, enter `control` and click OK to open Control Panel
![Run Control](/images/docs/quickstart/windows/router-1.png)
![Run Control](/images/docs/quick-start/windows/router-1.png)
3. Navigate to `Network and Internet > Network and Sharing Center`
4. Click on the internet connection under Connections
![Ethernet Connection](/images/docs/quickstart/windows/router-2.png)
![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.
![Network Connection Details](/images/docs/quickstart/windows/router-3.png)
![Network Connection Details](/images/docs/quick-start/windows/router-3.png)
5. go to https://ipv4.icanhazip.com and note the IP address
@ -96,19 +96,19 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
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.
![ASUS router settings page](/images/docs/quickstart/windows/router-4.png)
![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.
![Static DHCP](/images/docs/quickstart/windows/router-5.png)
![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
10. Forward ports 80 and 443 to the IP you assigned previously
![Port Forwarding](/images/docs/quickstart/windows/router-6.png)
![Port Forwarding](/images/docs/quick-start/windows/router-6.png)
### Install Caddy
@ -116,29 +116,29 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
1. go to 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/quickstart/windows/caddyinst-1.png)
![Caddy Download](/images/docs/quick-start/windows/caddyinst-1.png)
3. Create a new folder under C:\ and name it caddy
![Create Caddy folder](/images/docs/quickstart/windows/caddyinst-2.png)
![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
![Place Caddy exe](/images/docs/quickstart/windows/caddyinst-3.png)
![Place Caddy exe](/images/docs/quick-start/windows/caddyinst-3.png)
5. go to `This PC` in Explorer, right click on blank space and click on `properties`
![This PC Right Click Menu](/images/docs/quickstart/windows/caddyinst-4.png)
![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
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/quickstart/windows/caddyinst-5.png)
![Environment Variables](/images/docs/quick-start/windows/caddyinst-5.png)
8. Click on `New` in the popup and enter `C:\caddy`, then click `OK` on the bottom right
![New PATH value](/images/docs/quickstart/windows/caddyinst-6.png)
![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
@ -147,18 +147,18 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
1. Open a terminal and run `caddy respond --body test --listen :80`
![Caddy Terminal](/images/docs/quickstart/windows/httptest-1.png)
![Caddy Terminal](/images/docs/quick-start/windows/httptest-1.png)
3. Allow access if prompted by Windows Firewall
4. Your IP may have changed while making the changes in your router. Go to https://ipv4.icanhazip.com to get your current public IP address
![My IP](/images/docs/quickstart/windows/httptest-2.png)
![My IP](/images/docs/quick-start/windows/httptest-2.png)
5. Attempt to access `http://<your IP here>` using another internet connection on another device such as your mobile data. For this case, the IP has changed to `1.171.xxx.xxx` so I will be accessing http://1.171.xxx.xxx using my mobile data on my phone.
6. The page should look like the picture below. If it doesn't look this way or fails to connect, your ISP may be blocking incoming http connections or your IP is not routable. In this case, you should stop following this guide and look for other remote access options.
![test success ios](/images/docs/quickstart/windows/httptest-3.png)
![test success ios](/images/docs/quick-start/windows/httptest-3.png)
Screenshot taken on iOS using Safari
@ -171,27 +171,27 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
1. Login to DuckDNS on the top right at https://www.duckdns.org/
2. Add a new domain in the middle. I am using jellyfintest12345.duckdns.org for this example but you can use anything as long as it hasn't been taken
![duckdns dashboard](/images/docs/quickstart/windows/ddns-1.png)
![duckdns dashboard](/images/docs/quick-start/windows/ddns-1.png)
3. Download the latest windows client zip from https://github.com/XWolfOverride/DuckDNS/releases
4. create a new subfolder under C:\ and name it `duckdns`
![duckdns folder](/images/docs/quickstart/windows/ddns-2.png)
![duckdns folder](/images/docs/quick-start/windows/ddns-2.png)
5. Unzip the downloaded file and move the `DuckDNS.exe` into the folder
![duckdns exe](/images/docs/quickstart/windows/ddns-3.png)
![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
![duckdns client interface](/images/docs/quickstart/windows/ddns-4.png)
![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
![run task scheduler](/images/docs/quickstart/windows/ddns-5.png)
![run task scheduler](/images/docs/quick-start/windows/ddns-5.png)
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
@ -199,15 +199,15 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
13. Choose `Start a program` for the Action
14. Enter `C:\duckdns\DuckDNS.exe` in the Program/script field
![create duckdns task](/images/docs/quickstart/windows/ddns-6.png)
![create duckdns task](/images/docs/quick-start/windows/ddns-6.png)
15. Check Open the Properties dialog checkbox and click Finish
![finish wizard](/images/docs/quickstart/windows/ddns-7.png)
![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
![duckdns task properties](/images/docs/quickstart/windows/ddns-8.png)
![duckdns task properties](/images/docs/quick-start/windows/ddns-8.png)
### Reverse Proxy with Caddy
@ -215,7 +215,7 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
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.
![file extension change confirmation](/images/docs/quickstart/windows/reverseproxy-1.png)
![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):
@ -234,13 +234,13 @@ 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 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/quickstart/windows/reverseproxy-2.png)
![Networking Settings](/images/docs/quick-start/windows/reverseproxy-2.png)
7. open a terminal in the caddy folder and run `caddy start`. If there are no errors, you can safely close the terminal.
8. 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.
13. hit Win + R, enter `taskschd.msc` and click OK
![run taskschd](/images/docs/quickstart/windows/reverseproxy-3.png)
![run taskschd](/images/docs/quick-start/windows/reverseproxy-3.png)
11. Click on Create basic task on the right panel.
12. Enter a descriptive Name and a description, one that you can identify in the future and click next
@ -249,15 +249,15 @@ See [Hardware Acceleration](https://jellyfin.org/docs/general/administration/har
15. Enter `C:\caddy\caddy.exe` in the Program/script field, `run` in the arguments field and `C:\caddy` in the Start in field, then click Next
16. Check Open the Properties dialog checkbox and click Finish
![create caddy task](/images/docs/quickstart/windows/reverseproxy-4.png)
![create caddy task](/images/docs/quick-start/windows/reverseproxy-4.png)
17. Go to the Settings Pane in the dialog and uncheck the `Stop the task if it runs longer than` checkbox, then click OK
![caddy task propeties](/images/docs/quickstart/windows/reverseproxy-5.png)
![caddy task propeties](/images/docs/quick-start/windows/reverseproxy-5.png)
18. Reboot to test configuration. There will be a Terminal window open after bootup. This is normal.
![running caddy terminal](/images/docs/quickstart/windows/reverseproxy-6.png)
![running caddy terminal](/images/docs/quick-start/windows/reverseproxy-6.png)
## References

View File

Before

Width:  |  Height:  |  Size: 73 KiB

After

Width:  |  Height:  |  Size: 73 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 5.3 KiB

View File

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 110 KiB

View File

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 61 KiB

After

Width:  |  Height:  |  Size: 61 KiB

View File

Before

Width:  |  Height:  |  Size: 6.8 KiB

After

Width:  |  Height:  |  Size: 6.8 KiB

View File

Before

Width:  |  Height:  |  Size: 5.4 KiB

After

Width:  |  Height:  |  Size: 5.4 KiB

View File

Before

Width:  |  Height:  |  Size: 9.5 KiB

After

Width:  |  Height:  |  Size: 9.5 KiB

View File

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 26 KiB

After

Width:  |  Height:  |  Size: 26 KiB

View File

Before

Width:  |  Height:  |  Size: 57 KiB

After

Width:  |  Height:  |  Size: 57 KiB

View File

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 5.3 KiB

View File

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 98 KiB

View File

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

Before

Width:  |  Height:  |  Size: 305 KiB

After

Width:  |  Height:  |  Size: 305 KiB

View File

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

View File

Before

Width:  |  Height:  |  Size: 6.7 KiB

After

Width:  |  Height:  |  Size: 6.7 KiB

View File

Before

Width:  |  Height:  |  Size: 65 KiB

After

Width:  |  Height:  |  Size: 65 KiB

View File

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 25 KiB

After

Width:  |  Height:  |  Size: 25 KiB

View File

Before

Width:  |  Height:  |  Size: 87 KiB

After

Width:  |  Height:  |  Size: 87 KiB

View File

Before

Width:  |  Height:  |  Size: 9.2 KiB

After

Width:  |  Height:  |  Size: 9.2 KiB

View File

Before

Width:  |  Height:  |  Size: 4.5 KiB

After

Width:  |  Height:  |  Size: 4.5 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 181 KiB

After

Width:  |  Height:  |  Size: 181 KiB

View File

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

View File

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB