diff --git a/README.md b/README.md index 23d422f..4f4567e 100644 --- a/README.md +++ b/README.md @@ -283,7 +283,32 @@ run this command to build the docker `docker build -t ultrasinger .` make sure to include the "." at the end let this run till complete. then run this command -`docker run --gpus all -it --name UltraSinger -v $(pwd)/src/output:/app/src/output ultrasinger` +`docker run --gpus all -it --name UltraSinger -v $pwd/src/output:/app/src/output ultrasinger` + +Docker-Compose +there are two files that you can pick from. +cd into `docker-compose` folder and then cd into `Nvidia` or `NonGPU` +Run `docker-compose up` to download and setup + +Nvidia is for if you have a nvidia gpu to use with UltraSinger. +NonGPU is for if you wish to only use the CPU for UltraSinger. + +Output +by default the docker-compose will setup the output folder as `/output` inside the docker. +on the host machine it will map to the folder with the `docker-compose.yml` file under `output` +you may chnage this by editing the `docker-compose.yml` + +to edit the file. +use any text editor you wish. i would recoment nano. +run `nano docker-compose.yml` +then change this line +` - ./output:/app/UltraSinger/src/output` +to anything you line for on your host machine. +` - /yourfolderpathhere:/app/UltraSinger/src/output` +sample +` - /mnt/user/appdata/UltraSinger:/output` +note the blank space before the `-` +formating is important here in this file. this will create and drop you into the docker. now run this command. @@ -293,6 +318,7 @@ or to use mp3's in the folder you git cloned you must place all songs you like in UltraSinger/src/output. this will be the place for youtube links aswell. + to quit the docker just type exit. to reenter docker run this command diff --git a/docker-compose/NonGPU/docker-compose.yml b/docker-compose/NonGPU/docker-compose.yml new file mode 100644 index 0000000..b1f75c9 --- /dev/null +++ b/docker-compose/NonGPU/docker-compose.yml @@ -0,0 +1,10 @@ +--- +version: "3.9" +services: + ultrasinger: + stdin_open: true + tty: true + container_name: UltraSinger + volumes: + - ./output:/app/UltraSinger/src/output + image: rakuri255/ultrasinger:latest diff --git a/docker-compose/NonGPU/output/.dontremove b/docker-compose/NonGPU/output/.dontremove new file mode 100644 index 0000000..f36cc91 --- /dev/null +++ b/docker-compose/NonGPU/output/.dontremove @@ -0,0 +1 @@ +this file is here to save folder path diff --git a/docker-compose/Nvidia/docker-compose.yml b/docker-compose/Nvidia/docker-compose.yml new file mode 100644 index 0000000..6305af3 --- /dev/null +++ b/docker-compose/Nvidia/docker-compose.yml @@ -0,0 +1,18 @@ +--- +version: "3.9" +services: + ultrasinger: + deploy: + resources: + reservations: + devices: + - driver: nvidia + count: all + capabilities: + - gpu + stdin_open: true + tty: true + container_name: UltraSinger + volumes: + - ./output:/app/UltraSinger/src/output + image: rakuri255/ultrasinger:latest diff --git a/docker-compose/Nvidia/output/.donotremove b/docker-compose/Nvidia/output/.donotremove new file mode 100644 index 0000000..f36cc91 --- /dev/null +++ b/docker-compose/Nvidia/output/.donotremove @@ -0,0 +1 @@ +this file is here to save folder path