-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Added versioning * Moved main site link to the left
- Loading branch information
Showing
431 changed files
with
30,223 additions
and
8 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 changes: 8 additions & 0 deletions
8
i18n/bg-BG/docusaurus-plugin-content-docs/version-13.x/configuration/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "", | ||
"position": "", | ||
"link": { | ||
"type": "", | ||
"description": "" | ||
} | ||
} |
449 changes: 449 additions & 0 deletions
449
...bg-BG/docusaurus-plugin-content-docs/version-13.x/configuration/external-api.md
Large diffs are not rendered by default.
Oops, something went wrong.
105 changes: 105 additions & 0 deletions
105
...cusaurus-plugin-content-docs/version-13.x/configuration/security-and-privacy.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
# Security and Privacy | ||
|
||
UMS is a DLNA server. Now DLNA is a protocol that doesn't have any real notion of a "user". You don't have to "logon" to your TV for example. This leads to that all renderers get access to the same data. This might not be what you want. For example if you have two folders kids_safe and kids_unsafe you might want restrict the renderers in the kids room to only have access to the kids_safe folder. UMS provides a number of methods to control the access. | ||
|
||
## IP filter | ||
|
||
IP filtering is the most restrictive method that UMS provides. To use you supply a comma-separated list of IP-addresses that are allowed to connect. A render whose address does not match the entries in the list will simply get its traffic discarded (very early by UMS). It will not be able to access ANY folders (it will not even see a root folder). Use this method to block out the kids altogether. See description of ip_filter in UMS.conf for more details. | ||
|
||
Example to allow only 2 addresses | ||
|
||
``` | ||
ip_filter = 192.168.1.4, 192.168.1.32 | ||
``` | ||
|
||
## Allowlist | ||
|
||
Allowlisting is a method that allows you to customize the rootfolder on a per render basis. This makes it possible to share different folder sets to different renderers. It works as follow: To your UMS.conf (currently no GUI options) you add lines of format tag.option = value where tag is either an IP address or a render name. The render name should be with spaces changed to _ (underscore) instead. The option is one of | ||
|
||
- folders | ||
- vfolders | ||
- web | ||
- hide_set | ||
|
||
The value is option dependent. The last 4 are boolean values. for folders and virtualfolders it is a list of folders. | ||
|
||
Example | ||
|
||
``` | ||
folders = | ||
hide_video_settings = false | ||
192.168.1.1.folders = c:\\child_safe | ||
192.168.1.1.hide_set = true | ||
``` | ||
|
||
This will for IP address 192.168.1.1: | ||
|
||
- Share the folder c:\child_safe | ||
- Hide the Server Settings folder | ||
- Hide the Recently played list | ||
|
||
All other renderers will use the "global" settings i.e. see all folders, and the Server Settings. | ||
|
||
If an option is not present it will fallback to the "global" config or if that isn't present to the default value. | ||
|
||
## UMS.deny | ||
|
||
The whitelist can only modify the rootfolder appearance. But if you have mixed things (you have 10 folders but only one should be restricted to the kids). To control access to individual folders (or media) you can use the UMS.deny. It works as follows: Add a file called UMS.deny into the same directory as your UMS.conf file and inside that file add tag.[name|file|sys]=regex For each folder/file that should be added, UMS will apply the regular expression to the folder name or filename and if the regular expression matches the folder/file will NOT be added. For example: | ||
``` | ||
192.168.1.1.name=.*private.* | ||
``` | ||
|
||
will remove all folders/files which has the word private in it. | ||
``` | ||
192.168.1.1.file=c:\\tst.* | ||
``` | ||
|
||
will remove all files that have c:\tst in their path etc. | ||
|
||
If no rule are set in the "UMS.deny" file, the files/folders will be added. | ||
|
||
Hiding folders | ||
|
||
Control the visibility of the virtual folders. These settings can be found in UMS.conf file. To hide some folders while browsing, just set their value to true or tick them in the Navigation/Share Settings tab from the advanced GUI mode. | ||
|
||
``` | ||
hide_recently_played_folder =true | ||
hide_new_media_folder =true | ||
hide_video_settings =true | ||
hide_transcode_folder =true | ||
hide_empty_folders =true | ||
hide_media_library_folder =true | ||
hide_live_subtitles_folder =true | ||
``` | ||
|
||
To hide the Web folder, you will need to untick Enable external network in General Configuration tab from the advanced GUI mode or change the `external_network =' value to false in your UMS.conf file. This will have the side effect that the automatic updater won't work. The change(s) made from the GUI will be effective after a restart. | ||
|
||
## PIN code | ||
|
||
All the above methods restricts access from various renderers. But if you can get access to a render that is allowed to see a folder those methods will not help you (if the kids has access to the living room tv which have access to all media then they have access to that media). The PIN code solves this issue. It allows you to hide folders/media behind a PIN code which you must enter FROM the render. By default the input is a sequence of digits (0-9) just like an ATM code. I strongly suggests that you use digit based codes as it becomes hard to type in from the renderer. But if you are extra paranoid you can add letters. It works as follows: Add a file called UMS.code to the same directory as your UMS.conf and to that file add regexp,code where regexp is a regular expression just like in "UMS.deny" file and code is the code that will grant access to the folder/media. There is no length regulation on the code. For example: | ||
``` | ||
.*private.*,1234 | ||
``` | ||
|
||
Will force you to enter a code if the folder/media contains the word "private" and the correct code is 1234. The code then stays valid for 4 hours (if you don't change that time). | ||
|
||
## Custom Device Configuration | ||
|
||
Any configuration property can also be set on a per-device basis by creating a custom device configuration to override the default UMS settings (for full details see Creating a Custom Device Configuration). | ||
|
||
For example, to customize the kids' TV: | ||
- Click the 'Customize this device' button in the top right of the renderer's GUI popup panel and specify a name for the configuration. | ||
- In the new conf file that opens up add any settings you wish to override for the TV, e.g. to change the server name and specify different folders: | ||
``` | ||
#---------------------------------------------------------------------------- | ||
# Custom Device profile | ||
# See DefaultRenderer.conf for descriptions of all possible renderer options | ||
# and UMS.conf for program options. | ||
# Options in this file override the default settings for the specific Sony Bravia EX device(s) listed below. | ||
# Specify devices by uuid (or address if no uuid), separated by commas if more than one. | ||
device = uuid:7744ff6c-541f-48a8-0878-05fdebf240db | ||
server_name = Kid Stuff | ||
folders = c:\kids\stuff, c:\kids\otherstuff | ||
``` |
8 changes: 8 additions & 0 deletions
8
i18n/bg-BG/docusaurus-plugin-content-docs/version-13.x/guides/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "", | ||
"position": "", | ||
"link": { | ||
"type": "", | ||
"description": "" | ||
} | ||
} |
11 changes: 11 additions & 0 deletions
11
...plugin-content-docs/version-13.x/guides/how-to-improve-support-for-my-device.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
# How to improve support for my device | ||
|
||
If your device is failing to do anything, like browsing folders or playing a file, it may be possible for you to fix it by changing settings in the renderer config file. Different devices/renderers/clients communicate with servers like UMS in different ways, so the config file tells UMS how to speak the same language as your device. | ||
|
||
We have a default renderer config file that contains documentation on all of our renderer settings. See the latest version at https://github.com/UniversalMediaServer/UniversalMediaServer/blob/master/src/main/external-resources/renderers/DefaultRenderer.conf | ||
|
||
Common settings to look at are `SeekByTime`, `TranscodeVideo`, `TranscodedVideoFileSize`, and `ChunkedTransfer`. | ||
|
||
As well as that, you can have a look at other renderer configs inside the "renderers" folder in your installation directory, to see what they are doing. Sometimes you will need help, which we can give you on our forum, and please remember to tell us about the improvement when you make it, so that other users with your device can benefit from the fix. We will credit you in our release announcement and changelog. | ||
|
||
If you have a new renderer config to contribute to the project, please create a **Pull Request** on our GitHub repository https://github.com/UniversalMediaServer/UniversalMediaServer |
39 changes: 39 additions & 0 deletions
39
i18n/bg-BG/docusaurus-plugin-content-docs/version-13.x/guides/how-to-play-media.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# How to play media | ||
|
||
This article will explain the 4 main ways to play video, audio and images via UMS. | ||
|
||
## 1: Play from a renderer interface | ||
|
||
When your renderer is connected to UMS via DLNA/UPnP, often it will display in a menu called "Media Servers" or something similar, depending on the renderer. From there, you can enter UMS and browse to the media you want to access. | ||
|
||
The implementation of this varies greatly per renderer, but the core functionality is the same; navigate to your chosen media and select it to play. | ||
|
||
## 2: Push from the UMS interface to a renderer | ||
|
||
The UMS interface itself has the ability to "push" media to renderers if they support the UPnP feature. It is a similar concept to casting. | ||
|
||
1. Open the UMS UI and identify the renderer you want to push media to. In this case it is the Panasonic VIERA VT60 Series TV. | ||
![Open the GUI](@site/docs/guides/img/how-to-play-media-1.png) | ||
2. Click on the renderer image to open the control panel | ||
![Renderer control](@site/docs/guides/img/how-to-play-media-2.png) | ||
3. Choose the file you want to push by clicking the folder icon on the lower right, and it will be filled in on the lower left. If you do not see the player controls in this window, your renderer does not support this functionality. Be sure to check for firmware/software updates to your renderer as they may have added support for it | ||
![File selected](@site/docs/guides/img/how-to-play-media-3.png) | ||
4. Now you can either create a playlist by clicking the plus icon to the immediate right of the input box, or you can push the file to your renderer by clicking the play icon just above the middle of the input box, which will start it playing on your renderer. | ||
|
||
## 3: Play on the web interface | ||
|
||
The web interface can be accessed anywhere within your local network, including on computers and renderers. In many ways it offers our most advanced UI and features. | ||
|
||
1. Open the web interface. If you know the address you can go to that, otherwise an easy way is to click the Web interface button on our UI | ||
![Open the web interface](@site/docs/guides/img/how-to-play-media-4.png) | ||
2. Clicking that will open the web interface in your default browser. From there you can navigate to your file and click to play it | ||
![Video on the web interface](@site/docs/guides/img/how-to-play-media-5.png) | ||
|
||
## 4: Push from the web interface to a renderer | ||
|
||
Similar to above in option 2, you can push your media to a renderer via our web interface. | ||
|
||
1. Clicking the little cast icon for a file when browsing a directory. It is on the lower right of the thumbnail. | ||
![Cast icon](@site/docs/guides/img/how-to-play-media-6.png) | ||
2. That will make a mini floating control panel appear, which you can use to control playback of the file, and manage dynamic playlists if you choose. | ||
![Floating control panel](@site/docs/guides/img/how-to-play-media-7.png) |
12 changes: 12 additions & 0 deletions
12
...rus-plugin-content-docs/version-13.x/guides/how-to-solve-connection-problems.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
# How to solve connection problems | ||
|
||
This page provides solutions for the most common connection problems our users encounter. | ||
|
||
## UMS detects renderer, but renderer does not detect UMS | ||
|
||
This usually happens when your computer has more than one active network connection (for example, one wired and one wireless). You can solve it by setting which network interface you want: | ||
|
||
1. Open UMS | ||
2. Select the `General Settings` tab | ||
3. Expand the `Force networking on interface:` dropdown and select the interface you want. There might be a lot of options in the dropdown. The one you want will usually have an IP address in brackets after the name, for example: | ||
![Open the GUI](@site/docs/guides/img/how-to-solve-connection-problems.png) |
31 changes: 31 additions & 0 deletions
31
...-plugin-content-docs/version-13.x/guides/how-to-use-the-fully-played-feature.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# How to use the "Fully played" feature | ||
|
||
The "Fully played" feature lets you keep track of files you have fully played; for a video it means you have watched at least 92%, and for audio you have listened to at least 92%. | ||
|
||
## Setup | ||
|
||
This feature is enabled by default, so if you have not changed anything, you can use it. If the feature is not working, please check that these steps have not been undone: | ||
|
||
1. On the **Navigation Settings** tab, select the **Enable the cache** checkbox. This is enabled by default. | ||
2. On the **Navigation Settings** tab, choose your **Fully played action**. In particular, make sure you have not selected **Do nothing**. This is **Mark media** by default, which will overlay an icon on the thumbnail to indicate it has been watched. | ||
3. On the **Shared Content** tab, find the folder you want to track, and select the **Monitor played status of files** checkbox on that row. | ||
|
||
## Marking files as fully played automatically | ||
|
||
After you have completed the setup steps, you just need to play 92% or more of a file. | ||
|
||
## Marking files as fully played manually | ||
|
||
To mark all files within a shared directory as fully played: | ||
|
||
On the **Shared Content** tab, right-click on the directory you want to mark as fully played, and then click **Mark contents fully played** | ||
|
||
![Open the GUI](@site/docs/guides/img/how-to-use-the-fully-played-feature.png) | ||
|
||
## Removing fully played status / unplaying | ||
|
||
To "unplay" a file, you can do one of the following options: | ||
|
||
- Rename the file in any way. You can put it back to its original name after that, because UMS will have cleared the entry from its cache when you changed the name. | ||
- Move the file to another directory. You can put it back to its original directory after that, because UMS will have cleared the entry from its cache when you moved the file. | ||
- To "unplay" a whole shared directory, on the **Shared Content** tab, right-click on the directory to mark as unplayed, and then click **Mark contents unplayed**. |
8 changes: 8 additions & 0 deletions
8
i18n/bg-BG/docusaurus-plugin-content-docs/version-13.x/installation/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
{ | ||
"label": "", | ||
"position": "", | ||
"link": { | ||
"type": "", | ||
"description": "" | ||
} | ||
} |
108 changes: 108 additions & 0 deletions
108
i18n/bg-BG/docusaurus-plugin-content-docs/version-13.x/installation/docker.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
# Docker | ||
|
||
Some of these steps may not apply to your installation. Understand what they do, and ignore, or customize as necessary. | ||
|
||
## Preparation | ||
|
||
For operating system support and service packages. | ||
|
||
### Debian Linux | ||
|
||
Install Docker (Engine): https://docs.docker.com/engine/install/debian/ | ||
|
||
### Fedora Linux | ||
|
||
Install Docker (Engine): https://docs.docker.com/engine/install/fedora/ | ||
|
||
#### Extra instructions | ||
|
||
``` | ||
sudo usermod -a -G docker <username>; | ||
``` | ||
|
||
Re-login or restart the machine. | ||
|
||
``` | ||
sudo su -; | ||
mkdir /srv/UMS; | ||
chcon -t svirt_sandbox_file_t /srv/UMS; | ||
chgrp docker /srv/UMS; | ||
chmod -R g+w /srv/UMS; | ||
``` | ||
|
||
Mount storage to host and link into that directory, probably read-only. `mount <Videos-Share> '/srv/UMS/Videos'` | ||
|
||
Test example: Simple symlinking to another path on the host system may not work, since there will be no access to it outside of the mounted volume path for the docker container. Try copying files inside this location instead. | ||
|
||
## Container Setup | ||
|
||
Mount the following volumes: | ||
- Media folder `/media` | ||
- Profile folder containing UMS.conf `/profile` | ||
|
||
Expose/forward these ports from the host: 1044, 5001, 9001. | ||
|
||
The following scripts accomplish that (using the fish shell): | ||
``` | ||
sudo su -; | ||
set rootDir "$HOME/.config/UMS"; | ||
mkdir -p "$rootDir/data"; | ||
| ||
docker pull universalmediaserver/ums; | ||
| ||
docker create --name UMS \ | ||
-p 1044:1044 -p 5001:5001 -p 9001:9001 \ | ||
-v /srv/UMS:/root/media \ | ||
-v "$HOME/.config/UMS":/root/.config/UMS \ | ||
universalmediaserver/ums \ | ||
; | ||
| ||
docker start UMS; | ||
``` | ||
|
||
## Investigating Problems/Issues | ||
|
||
### General | ||
|
||
``` | ||
docker ps -a; | ||
#docker attach [--no-stdin] UMS; # Still unintentionally stops container when done inspecting.. | ||
docker container logs [-f] UMS; | ||
docker exec -it UMS /bin/sh; | ||
docker diff UMS; | ||
``` | ||
|
||
For detailed logs in the terminal: `echo -e '\nlog_level=ALL' >> UMS.conf` | ||
|
||
``` | ||
docker cp <containerName>:/var/log/UMS/root/debug.log ./; | ||
``` | ||
|
||
### Mount trouble | ||
|
||
Using Fedora CoreOS, I had access/permission denied problems trying to use bind mounts. | ||
|
||
It may be recommended to use the Docker-managed, named-volumes capability instead, but to avoid that complexity, I found that the additional `:Z` as a suffix to the bind mount's descriptor option value allowed container write access to host files. `:z` can also be used instead, but security advice may suggest keeping resources more isolated between application/service environments, rather than shared. | ||
|
||
Matching error messages can be seen using journalctl, so it is an SELinux problem. The solution for that would be to run `chcon -Rt svirt_sandbox_file_t` host_dir, but that also seems discouraged. | ||
|
||
Strangely this is not an issue on Fedora Workstation, but I guess installing it manually added a package to deal with this. Seems to be container-selinux. | ||
|
||
## References | ||
|
||
- https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label | ||
- https://drive.google.com/file/d/1ORNc113a8is1K1ZZtp1r3iz44uzJDeRp/view | ||
- https://fedora.pkgs.org/36/docker-ce-x86_64/docker-ce-20.10.16-3.fc36.x86_64.rpm.html#Install_HowTo | ||
- https://github.com/UniversalMediaServer/UniversalMediaServer/blob/master/docker/Dockerfile | ||
- https://github.com/UniversalMediaServer/UniversalMediaServer/issues/1841 | ||
- https://github.com/UniversalMediaServer/UniversalMediaServer/issues/1841#issuecomment-672849793 | ||
- https://github.com/UniversalMediaServer/UniversalMediaServer/pull/1599 | ||
- https://github.com/UniversalMediaServer/UniversalMediaServer/tree/master/src/main/external-resources | ||
- https://hub.docker.com/r/universalmediaserver/ums | ||
- https://hub.docker.com/r/atamariya/ums/ | ||
- https://pkgs.org/download/docker-ce | ||
- https://support.universalmediaserver.com/ | ||
- https://www.universalmediaserver.com/download/#docker | ||
- https://www.universalmediaserver.com/forum/viewtopic.php?t=12922 | ||
- https://www.universalmediaserver.com/forum/viewtopic.php?t=14580 | ||
- https://www.universalmediaserver.com/forum/viewtopic.php?p=47952 |
Oops, something went wrong.