Skip to content
Badger Code edited this page Jun 16, 2025 · 2 revisions

πŸ“ˆ Usage

To use the program, you can either run it in python or within a Docker container:

Using Python

  1. Run the program
python ./app.py

Using Docker

πŸ“ Docker Notes
  1. Ensure you have Docker installed on your system. You can find installation instructions on the Docker website.
  2. The program uses Docker Compose to manage the container. Make sure you have Docker Compose installed as well.
  3. The program uses the docker compose command, which is the newer syntax for Docker Compose. If you have an older version of Docker Compose, you may need to use docker-compose instead.
  4. Some helpful commands:
groups # Check your user groups (you should see `docker` in the list)
newgrp docker # Create a new group session with the `docker` group
sudo usermod -aG docker $USER && sudo reboot # Add your user to the Docker group and reboot
  1. Build the Docker image
docker compose up
docker compose up -d # Run in detached mode
  1. Access the web interface Go to http://localhost:5000 in a web browser to access the Uniconverter web interface.
firefox http://127.0.0.1:5000
  1. Stop the Docker container (if ran in detached mode)
docker ps # List running containers
docker compose down
  1. Cleanup (optional)
docker compose down --volumes --remove-orphans # Remove volumes and orphan containers
docker images # List docker images
docker rmi uniconverter-web # Remove the Docker image
πŸ’» Command Line Arguments
Argument Description Default
-h & --help Help menu
--cleanup Delete optional files on exit False

πŸ“š Wiki Navigation

Clone this wiki locally