deemixer/README.md

67 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2023-12-21 21:56:53 +00:00
# Deemixer
2021-05-29 16:32:29 +00:00
2023-12-21 21:56:53 +00:00
This is forked from [deemix-webui](https://gitlab.com/RemixDev/deemix-webui) and [deemix-gui](https://gitlab.com/RemixDev/deemix-webui).
The submodule reference was removed and consolidated into this single repo. Git history was maintained.
2021-05-29 16:32:29 +00:00
2023-12-21 22:44:50 +00:00
## Building Docker Image
make docker_build_local
2023-12-22 21:12:52 +00:00
## Running Docker Image
docker run -d \
-v ./downloads/:/downloads \
-v ./config:/config \
-e PUID=1000 \
-e PGID=1000 \
-e UMASK_SET=022 \
-e DEEMIX_SINGLE_USER=true \
-p 6595:6595 \
gitea.va.reichard.io/evan/deemixer:latest
2021-05-29 16:32:29 +00:00
## Running from source
2023-12-21 21:56:53 +00:00
You need to use nodejs 16.x, using `yarn` is recommended.
2021-05-29 16:32:29 +00:00
2022-11-22 20:58:52 +00:00
Install the dependencies using `yarn install-all` for production.
Install the dependencies using `yarn install-all-dev` for development.
2021-05-29 16:32:29 +00:00
Then you should be able to run the app with `yarn start`.
2022-11-22 20:59:34 +00:00
If you want to further develop deemix-gui and propose a PR, use `yarn dev`
2022-11-22 20:58:52 +00:00
2022-11-22 20:59:34 +00:00
Commands for easy setup:
2022-11-22 20:58:52 +00:00
```sh
# Production
2023-12-21 21:56:53 +00:00
git clone https://gitea.va.reichard.io/evan/Deemixer.git . && yarn install-all
2022-11-22 20:58:52 +00:00
# Development
2023-12-21 21:56:53 +00:00
git clone https://gitea.va.reichard.io/evan/Deemixer.git . && yarn install-all-dev
2022-11-22 20:58:52 +00:00
```
2021-05-29 16:32:29 +00:00
2021-05-29 16:35:40 +00:00
You can change the default port by setting the environment variable `PORT` to any other number before starting the app.
2021-05-29 16:32:29 +00:00
## Building the app
2023-12-21 21:56:53 +00:00
To build the app you need to have git installed and the repo cloned with `git`.
2022-11-22 20:58:52 +00:00
Make sure you've installed the dependencies for all packages (the root folder, `server` and `webui`).
Then from the root folder run `yarn dist` to make a distributable package for your current OS or `yarn dist-server` to make an executable for only the server.
2021-05-29 16:32:29 +00:00
## Feature requests
2023-12-21 21:56:53 +00:00
2021-05-29 16:32:29 +00:00
Before asking for a feature make sure it isn't an already open issue on the repo
# License
2023-12-21 21:56:53 +00:00
2021-05-29 16:32:29 +00:00
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
2023-12-21 21:56:53 +00:00
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2021-05-29 16:32:29 +00:00
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
2022-11-22 20:58:52 +00:00
along with this program. If not, see <https://www.gnu.org/licenses/>.