filiprojek/walauncher repository overview

⁠WALauncher

WALauncher is a web-based launcher designed as an alternative to Muximux⁠, primarily used for managing various web services like Servarr apps. However, it can be configured to launch and manage any web application.

GitHub repository⁠

⁠Usage

⁠Using Docker

1. Create docker-compose.yaml

   Create a docker-compose.yaml file in your project directory:

   services:
     walauncher:
       image: filiprojek/walauncher:latest
       container_name: walauncher
       ports:
         - 5200:80
       volumes:
         - ./walauncher/config.json:/var/www/html/config.json
         - ./walauncher/img/:/var/www/html/img/
       restart: unless-stopped
   

   Copy

2. Start and Stop the Compose

   Start the containers:

   docker-compose up -d
   

   Copy

   Stop the containers:

   docker-compose down
   

   Copy

3. Configuration

   • cd to a newly created walauncher folder

   • Remove the config.json folder if it exists.

   • Create a config.json file in the project root with the following structure:

     {
         "apps": [
             {
                 "name": "Some service",
                 "img": "image_name.jpg",
                 "url": "http://localhost:8000/"
             },
             {
                 "name": "Some service",
                 "img": "image_name.jpg",
                 "url": "http://localhost:8100/"
             }
         ]
     }
     

     Copy

   Replace "Some service", "image_name.jpg", and "http://localhost:8000/" with your own service names, image filenames in the img/ folder, and their respective URLs.

4. Upload Icons and Images

   Upload your service icons (.svg, .jpg, etc.) to the walauncher/img/ folder.

⁠Manual Setup (Without Docker)

• Manual setup is described in GitHub repository readme⁠

⁠Configuration

WALauncher supports additional optional configuration options to enhance customization. These options allow you to modify the behavior and appearance of the web application by adding an options object in the config.json file

⁠Example config.json with Options

{
    "apps": [
        {
            "name": "Some service",
            "img": "image_name.jpg",
            "url": "http://localhost:8000/"
        },
        {
            "name": "Some service",
            "img": "image_name.jpg",
            "url": "http://localhost:8100/"
        }
    ],
    "options": {
        "footer": true,
        "footertext": "Your customized footer where you can use <strong>HTML</strong>",
        "title": "My Home Launcher"
    }
}

⁠Options

• footer (boolean, default: true): Control the visibility of the footer.

  • Set footer to false to hide the footer completely from the site.

• footertext (string, optional): Customize the content of the footer.

  • Use this option to provide custom text for the footer. You can use HTML for formatting.

• title (string, optional): Customize the document title.

  • Change title to another value to customize the title displayed in the browser's title bar.

These options are entirely optional. If not specified, the default behavior will be applied.

⁠Contributing

Contributions are welcome! Fork the repository and submit a pull request with your changes. GitHub repository⁠

⁠Bug Reporting

If you encounter any bugs or issues, please report them here⁠.

⁠License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

⁠Docker Image

An official Docker image for walauncher is available on Docker Hub: filiprojek/walauncher⁠