Skip to content

mrishab/anton-apps

Repository files navigation

Anton Apps Collection

A curated collection of self-hosted applications using Docker and Docker Compose.

Overview

This repository contains a collection of Dockerized applications, each residing in its own directory. These applications cover a wide range of use cases, from media management to development tools.

Table of Contents

Setup Guide

Prerequisites

  • Docker Engine (19.03.0+)
  • Docker Compose (1.27.0+)
  • Git
  • Make (optional, but recommended)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/anton-apps.git
    cd anton-apps
  2. Configure the applications:

    • For each application you want to use, go to its directory and copy the template.env file:
      cd app-name
      cp template.env .env
    • Edit the .env file to set your preferred configuration values.
  3. Start the applications:

    • To start a specific application:
      make start app=app-name
    • To start all applications:
      make start-all

Using the Makefile

The repository includes a Makefile to simplify common operations:

  • make start app=app-name - Start a specific application
  • make stop app=app-name - Stop a specific application
  • make restart app=app-name - Restart a specific application
  • make logs app=app-name - View logs for a specific application
  • make start-all - Start all applications
  • make stop-all - Stop all applications

Contributing

Contributions to this collection are welcome! Here's how you can contribute:

Adding a New Application

  1. Create a new directory for your application:

    mkdir -p new-app-name
  2. Create the necessary files:

    • docker-compose.yml - Container configuration
    • template.env - Environment variable template
    • README.md - Documentation for your application
  3. Test your application:

    cd new-app-name
    cp template.env .env
    # Edit .env with appropriate values
    docker-compose up -d
  4. Submit a pull request with your changes.

Modifying Existing Applications

  1. Make your changes to the application
  2. Test thoroughly
  3. Submit a pull request with your changes

License

This collection is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

This collection builds upon the work of many open source projects and Docker image maintainers. See individual application directories for specific acknowledgements and references.

About

Home File Server based on dockerized Samba

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published