Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
9e81d36
New translations build-instructions.md (English, United Kingdom)
SubJunk May 29, 2026
9f29157
New translations build-instructions.md (Romanian)
SubJunk May 29, 2026
2e8a4fe
New translations development.md (Romanian)
SubJunk May 29, 2026
886c3b5
New translations build-instructions.md (French)
SubJunk May 29, 2026
119c59e
New translations development.md (French)
SubJunk May 29, 2026
c8d3726
New translations build-instructions.md (Spanish)
SubJunk May 29, 2026
eacd3d1
New translations development.md (Spanish)
SubJunk May 29, 2026
c092250
New translations build-instructions.md (Afrikaans)
SubJunk May 29, 2026
85e6319
New translations development.md (Afrikaans)
SubJunk May 29, 2026
bf5be8c
New translations build-instructions.md (Arabic)
SubJunk May 29, 2026
b360bd0
New translations development.md (Arabic)
SubJunk May 29, 2026
7aa31f1
New translations build-instructions.md (Bulgarian)
SubJunk May 29, 2026
83bb998
New translations development.md (Bulgarian)
SubJunk May 29, 2026
2c85515
New translations build-instructions.md (Catalan)
SubJunk May 29, 2026
85fae48
New translations development.md (Catalan)
SubJunk May 29, 2026
4e4c606
New translations build-instructions.md (Czech)
SubJunk May 29, 2026
eb17ef1
New translations development.md (Czech)
SubJunk May 29, 2026
c6f7c50
New translations build-instructions.md (Danish)
SubJunk May 29, 2026
2b74462
New translations development.md (Danish)
SubJunk May 29, 2026
a1b169c
New translations build-instructions.md (German)
SubJunk May 29, 2026
5abf8d9
New translations development.md (German)
SubJunk May 29, 2026
5bcaa57
New translations build-instructions.md (Greek)
SubJunk May 29, 2026
28624bc
New translations development.md (Greek)
SubJunk May 29, 2026
443bc13
New translations build-instructions.md (Finnish)
SubJunk May 29, 2026
89e1ea4
New translations development.md (Finnish)
SubJunk May 29, 2026
56b7bfa
New translations build-instructions.md (Hebrew)
SubJunk May 29, 2026
f838f51
New translations development.md (Hebrew)
SubJunk May 29, 2026
49ecdef
New translations build-instructions.md (Hungarian)
SubJunk May 29, 2026
afb6347
New translations development.md (Hungarian)
SubJunk May 29, 2026
f04a8c4
New translations build-instructions.md (Italian)
SubJunk May 29, 2026
7126ba3
New translations development.md (Italian)
SubJunk May 29, 2026
607247c
New translations build-instructions.md (Japanese)
SubJunk May 29, 2026
f3269c9
New translations development.md (Japanese)
SubJunk May 29, 2026
b5d22f9
New translations build-instructions.md (Korean)
SubJunk May 29, 2026
573c6e6
New translations development.md (Korean)
SubJunk May 29, 2026
6950f3e
New translations build-instructions.md (Dutch)
SubJunk May 29, 2026
2dfdabf
New translations development.md (Dutch)
SubJunk May 29, 2026
fa273b4
New translations build-instructions.md (Norwegian)
SubJunk May 29, 2026
e0b2cac
New translations development.md (Norwegian)
SubJunk May 29, 2026
630734a
New translations build-instructions.md (Polish)
SubJunk May 29, 2026
2c51147
New translations development.md (Polish)
SubJunk May 29, 2026
ba7d31a
New translations build-instructions.md (Portuguese)
SubJunk May 29, 2026
84f752d
New translations development.md (Portuguese)
SubJunk May 29, 2026
2365a41
New translations build-instructions.md (Russian)
SubJunk May 29, 2026
bac28bd
New translations development.md (Russian)
SubJunk May 29, 2026
cb13081
New translations build-instructions.md (Slovak)
SubJunk May 29, 2026
f45c1c8
New translations development.md (Slovak)
SubJunk May 29, 2026
db6729a
New translations build-instructions.md (Slovenian)
SubJunk May 29, 2026
a8df1ab
New translations development.md (Slovenian)
SubJunk May 29, 2026
9d7986c
New translations build-instructions.md (Serbian (Cyrillic))
SubJunk May 29, 2026
43860f3
New translations development.md (Serbian (Cyrillic))
SubJunk May 29, 2026
7f952f9
New translations build-instructions.md (Swedish)
SubJunk May 29, 2026
3f49f62
New translations development.md (Swedish)
SubJunk May 29, 2026
709f4f4
New translations build-instructions.md (Turkish)
SubJunk May 29, 2026
96ab9d7
New translations development.md (Turkish)
SubJunk May 29, 2026
e657fe4
New translations build-instructions.md (Ukrainian)
SubJunk May 29, 2026
5efaf38
New translations development.md (Ukrainian)
SubJunk May 29, 2026
a7fa3ce
New translations build-instructions.md (Chinese Simplified)
SubJunk May 29, 2026
a650f20
New translations development.md (Chinese Simplified)
SubJunk May 29, 2026
1fcae1d
New translations build-instructions.md (Chinese Traditional)
SubJunk May 29, 2026
0d7ad1f
New translations development.md (Chinese Traditional)
SubJunk May 29, 2026
0054485
New translations build-instructions.md (Vietnamese)
SubJunk May 29, 2026
0ef9e7a
New translations development.md (Vietnamese)
SubJunk May 29, 2026
4f293ef
New translations build-instructions.md (Icelandic)
SubJunk May 29, 2026
a1ada94
New translations development.md (Icelandic)
SubJunk May 29, 2026
9c661a8
New translations build-instructions.md (Portuguese, Brazilian)
SubJunk May 29, 2026
b087f43
New translations development.md (Portuguese, Brazilian)
SubJunk May 29, 2026
dd40d03
New translations build-instructions.md (Persian)
SubJunk May 29, 2026
a32d154
New translations development.md (Persian)
SubJunk May 29, 2026
7671a1f
New translations build-instructions.md (Croatian)
SubJunk May 29, 2026
27541bd
New translations development.md (Croatian)
SubJunk May 29, 2026
a7153a7
New translations build-instructions.md (Estonian)
SubJunk May 29, 2026
47ea2a2
New translations development.md (Estonian)
SubJunk May 29, 2026
767a643
New translations development.md (English, United Kingdom)
SubJunk May 29, 2026
92218d8
Update source file build-instructions.md
SubJunk May 29, 2026
8978711
Update source file development.md
SubJunk May 29, 2026
9bfc7b6
New translations security-and-privacy.md (Chinese Simplified)
SubJunk May 29, 2026
7fdc1fc
New translations security-and-privacy.md (Chinese Simplified)
SubJunk May 29, 2026
b13ad54
New translations development.md (Turkish)
SubJunk May 29, 2026
7ae79af
New translations development.md (Dutch)
SubJunk May 29, 2026
be1fa32
New translations how-to-add-web-content.md (Turkish)
SubJunk May 30, 2026
64ead7d
New translations development.md (Turkish)
SubJunk May 30, 2026
32b018e
New translations development.md (Turkish)
SubJunk May 30, 2026
718489b
New translations development.md (Czech)
SubJunk May 30, 2026
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
3 changes: 0 additions & 3 deletions docs/development/build-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ The following software packages are required:
* Maven
* [MediaInfo](https://mediaarea.net/en/MediaInfo/Download)

Read the [Full instructions](#full-instructions) section for a complete explanation of how to
install all required software and how to build UMS for each operating system.

# Short instructions

If all required software packages are installed, the following commands will
Expand Down
101 changes: 101 additions & 0 deletions docs/development/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Development

This document explains how to make and run your own changes.

## Forking the code to your machine

GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team.

* [Set up your machine for GitHub development](https://support.github.com/)

* Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right.

* Clone the new GitHub repo to your local machine. The clone URL can be seen
on the main page of your repository. It should be something like this
(replace YOURNAME with your actual GitHub name):

git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME

You now have the new repository on your local machine.

## Development with IDEs

### [VS Code](https://code.visualstudio.com/)

This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages.

#### Java server

When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them.
When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow.

#### Web browser interfaces

If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code.

In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files.

For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make.

For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player.

### [Eclipse](http://www.eclipse.org/downloads/)

* Install the m2e Eclipse plugin (http://eclipse.org/m2e/)

* Install the EGit Eclipse plugin (http://eclipse.org/egit/)

* In Eclipse, select the menu "Window > Show View > Git Repositories". Then
select "Window > Navigation > Show View Menu", choose "Add a Repository".
Browse for the directory where you cloned your repository and press the
"Search" button. Select your forked repository and press "OK".
The repository should appear in the Git Repositories view.

* Press the right mouse button on the repository and select "Import Maven
Projects" from the menu. Select the project "/pom.xml" and press "Finish".

Note: if a project with the same name already exists, click "Advanced" and
set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with
your GitHub name). Then press "Finish".

You now see the sources in Eclipse, but the project is still missing the "Git"
nature. In other words, it is not tied to the local repository yet. This means
you cannot perform any Git actions from Eclipse yet. Add the missing connection
by sharing the project:

* Press the right mouse button on the newly created project and select the
menu "Team > Share Project...". Select "Git" and press "Next >".
Check the checkbox "Use or create repository in parent folder of project"
and make sure the project is selected. Then press "Finish".

Verify that your project is now under Git control. Press the right mouse
button on the project and under "Team" you now see all options to work with
Git.

You can build UMS from Eclipse:

* Create a new run configuration under "Run > Run Configurations...", right
mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals:
`package`. Select the tab "JRE" and add the following VM arguments
`-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button.

You will want to run UMS from Eclipse while developing. This is how you do it:

* Create a new run configuration under "Run > Run Configurations...", right
mouse button on "Maven Build", select "New", Name: `Run UMS`, Base
directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`.
Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`.
Finally, press the "Apply" button.

You are now ready to start developing!

When you are happy with your changes, you can commit them to your local
repository from Eclipse using right mouse button, "Team > Commit...".

When you are satisfied with your commits and want to publish them to your
repository at GitHub, you can press the right mouse button on the project and
select "Team > Push to Upstream".

## Contributing your change back to us

If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details.
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ The following software packages are required:
- Maven
- [MediaInfo](https://mediaarea.net/en/MediaInfo/Download)

Read the [Full instructions](#full-instructions) section for a complete explanation of how to
install all required software and how to build UMS for each operating system.

# Short instructions

If all required software packages are installed, the following commands will
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Development

This document explains how to make and run your own changes.

## Forking the code to your machine

GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team.

- [Set up your machine for GitHub development](https://support.github.com/)

- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right.

- Clone the new GitHub repo to your local machine. The clone URL can be seen
on the main page of your repository. It should be something like this
(replace YOURNAME with your actual GitHub name):

git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME

You now have the new repository on your local machine.

## Development with IDEs

### [VS Code](https://code.visualstudio.com/)

This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages.

#### Java server

When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them.
When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow.

#### Web browser interfaces

If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code.

In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files.

For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make.

For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player.

### [Eclipse](http://www.eclipse.org/downloads/)

- Install the m2e Eclipse plugin (http://eclipse.org/m2e/)

- Install the EGit Eclipse plugin (http://eclipse.org/egit/)

- In Eclipse, select the menu "Window > Show View > Git Repositories". Then
select "Window > Navigation > Show View Menu", choose "Add a Repository".
Browse for the directory where you cloned your repository and press the
"Search" button. Select your forked repository and press "OK".
The repository should appear in the Git Repositories view.

- Press the right mouse button on the repository and select "Import Maven
Projects" from the menu. Select the project "/pom.xml" and press "Finish".

Note: if a project with the same name already exists, click "Advanced" and
set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with
your GitHub name). Then press "Finish".

You now see the sources in Eclipse, but the project is still missing the "Git"
nature. In other words, it is not tied to the local repository yet. This means
you cannot perform any Git actions from Eclipse yet. Add the missing connection
by sharing the project:

- Press the right mouse button on the newly created project and select the
menu "Team > Share Project...". Select "Git" and press "Next >".
Check the checkbox "Use or create repository in parent folder of project"
and make sure the project is selected. Then press "Finish".

Verify that your project is now under Git control. Press the right mouse
button on the project and under "Team" you now see all options to work with
Git.

You can build UMS from Eclipse:

- Create a new run configuration under "Run > Run Configurations...", right
mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals:
`package`. Select the tab "JRE" and add the following VM arguments
`-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button.

You will want to run UMS from Eclipse while developing. This is how you do it:

- Create a new run configuration under "Run > Run Configurations...", right
mouse button on "Maven Build", select "New", Name: `Run UMS`, Base
directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`.
Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`.
Finally, press the "Apply" button.

You are now ready to start developing!

When you are happy with your changes, you can commit them to your local
repository from Eclipse using right mouse button, "Team > Commit...".

When you are satisfied with your commits and want to publish them to your
repository at GitHub, you can press the right mouse button on the project and
select "Team > Push to Upstream".

## Contributing your change back to us

If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details.
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ The following software packages are required:
- Maven
- [MediaInfo](https://mediaarea.net/en/MediaInfo/Download)

Read the [Full instructions](#full-instructions) section for a complete explanation of how to
install all required software and how to build UMS for each operating system.

# Short instructions

If all required software packages are installed, the following commands will
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
# Development

This document explains how to make and run your own changes.

## Forking the code to your machine

GitHub makes it very simple for developers to fork their own version of the official UMS sources to add their own tweaks or features. GitHub facilitates submitting these features as "Pull Requests" to the official UMS development team.

- [Set up your machine for GitHub development](https://support.github.com/)

- Go to [the GitHub UMS repo](https://github.com/universalmediaserver/universalmediaserver) and press the `Fork` button on the top right.

- Clone the new GitHub repo to your local machine. The clone URL can be seen
on the main page of your repository. It should be something like this
(replace YOURNAME with your actual GitHub name):

git clone git@github.com:YOURNAME/universalmediaserver.git YOURNAME

You now have the new repository on your local machine.

## Development with IDEs

### [VS Code](https://code.visualstudio.com/)

This is our recommended editor because it is great at handling both Java and TypeScript, our two main languages.

#### Java server

When you have opened the code, you will probably see some recommendations for Extensions to install, like the `Extension Pack for Java`. Install it/them.
When that is installed and configured, you can run the Java server by clicking up the top `Run -> Start Debugging`, and reload it with `Run -> Restart Debugging`. These commands should complete within 1 second, for a fast development workflow.

#### Web browser interfaces

If you want to make changes to our web browser interfaces, you will also need to run the React server, which will take care of compiling and serving the TypeScript code.

In VS Code, you can go into the `Command Palette` and filter on `Debug: Select and Start Debugging` and select `Launch web interface`. It will automatically reload any changes you make to the React files.

For a manual workflow, you can go into the `react-client` folder and run `yarn` to download the necessary dependencies. Then just run `yarn dev` which should open the web player in the browser and automatically compile any code changes you make.

For the web settings interface, you can open `react-client/package.json` and change the proxy port from `9002` to `9001`. Now `yarn dev` should serve the web settings instead of web player.

### [Eclipse](http://www.eclipse.org/downloads/)

- Install the m2e Eclipse plugin (http://eclipse.org/m2e/)

- Install the EGit Eclipse plugin (http://eclipse.org/egit/)

- In Eclipse, select the menu "Window > Show View > Git Repositories". Then
select "Window > Navigation > Show View Menu", choose "Add a Repository".
Browse for the directory where you cloned your repository and press the
"Search" button. Select your forked repository and press "OK".
The repository should appear in the Git Repositories view.

- Press the right mouse button on the repository and select "Import Maven
Projects" from the menu. Select the project "/pom.xml" and press "Finish".

Note: if a project with the same name already exists, click "Advanced" and
set the "Name template" to `[artifactId]-YOURNAME` (replace YOURNAME with
your GitHub name). Then press "Finish".

You now see the sources in Eclipse, but the project is still missing the "Git"
nature. In other words, it is not tied to the local repository yet. This means
you cannot perform any Git actions from Eclipse yet. Add the missing connection
by sharing the project:

- Press the right mouse button on the newly created project and select the
menu "Team > Share Project...". Select "Git" and press "Next >".
Check the checkbox "Use or create repository in parent folder of project"
and make sure the project is selected. Then press "Finish".

Verify that your project is now under Git control. Press the right mouse
button on the project and under "Team" you now see all options to work with
Git.

You can build UMS from Eclipse:

- Create a new run configuration under "Run > Run Configurations...", right
mouse button on "Maven Build", select "New", Name: `Build UMS`, Goals:
`package`. Select the tab "JRE" and add the following VM arguments
`-Xmx1500m -XX:MaxPermSize=256m`. Finally, press the "Apply" button.

You will want to run UMS from Eclipse while developing. This is how you do it:

- Create a new run configuration under "Run > Run Configurations...", right
mouse button on "Maven Build", select "New", Name: `Run UMS`, Base
directory: `${project_loc}`, Goals: "test", Profiles: `run-from-eclipse`.
Select the tab "JRE" and add VM arguments `-Xmx1500m -XX:MaxPermSize=256m`.
Finally, press the "Apply" button.

You are now ready to start developing!

When you are happy with your changes, you can commit them to your local
repository from Eclipse using right mouse button, "Team > Commit...".

When you are satisfied with your commits and want to publish them to your
repository at GitHub, you can press the right mouse button on the project and
select "Team > Push to Upstream".

## Contributing your change back to us

If you would like to contribute to the UMS project, you can send a "Pull Request" to the development team. See [Creating a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) for more details.
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ The following software packages are required:
- Maven
- [MediaInfo](https://mediaarea.net/en/MediaInfo/Download)

Read the [Full instructions](#full-instructions) section for a complete explanation of how to
install all required software and how to build UMS for each operating system.

# Short instructions

If all required software packages are installed, the following commands will
Expand Down
Loading