borjapazr / mars-server Goto Github PK

View Code? Open in Web Editor NEW

79.0 4.0 8.0 467 KB

🏡🖥️ Managed home server with Docker, Docker Compose, Make and Bash

License: MIT License

Shell 2.56% Makefile 5.66% HTML 0.49% CSS 1.82% JavaScript 0.07% Dockerfile 0.40% Python 89.00%

docker docker-compose make makefile fzf homeserver lab linux nextcloud openvpn

mars-server's Introduction

🏡🖥️ Mars Server

Managed home server with Docker, Docker Compose, Make and Bash.

🧩 Requirements

🧑‍🍳 Configuration

Before deploying the services it is necessary to configure them. To do so, it is enough to create an .env file for each service with the content of the corresponding .env.template.

🏗️ Installation

server.sh install

🧙 Usage

Usage: server [OPTIONS] COMMAND

This script aims to manage a home server based on Docker, Docker Compose, Make and Bash.

Available options:
  -h, --help      Print this help and exit

Available commands:
  install         Install all services
  uninstall       Uninstall all services
  start           Start all services
  stop            Stop all services
  restart         Restart all services
  status          Get the status of all services
  services        Open a menu based on FZF to manage the services separately

🎯 Credits

To realise this project I have based myself on many similar projects. There were countless of them and I gave them all a star.

🙏 Thank you very much for these wonderful creations.

⭐ Stargazers

⚖️ License

The MIT License (MIT). Please see License for more information.

mars-server's People

Contributors

Stargazers

Watchers

Forkers

chewtoys bayeslearner dazeb clexanis linjan austinsonger luminescence buckarooh

mars-server's Issues

enhancement idea: incorporate https://github.com/alexaandrov/stitchocker

stitchocker is a single bash file that makes it possible to invoke a set of services (which possibly also relies on other sets of services) using a yaml manifest file.
Would be nice to incorporate this function to cut down the number of services running at the same time.

remove include .env line from makefile.

Why is this needed? For services that are disabled, .env may not exist yet.

server.sh services restart seems to destroy volumes

I am not sure why, but restart target of a service seems to be destroying volumes, instead of just stop and start.

By the way, there are many projects out there including homelabos, charjabox, make-my-server, ansible-nas-master, homeserver-compose and many more. Your little creation is so simple and yet concise.

a simple way to provide sensitive and/or dynamic env for docker-compose

I understand this is a simple tool not meant for production, but it would be nice if there is a simple elegant way to accomplish this, as having plain passwords lying around makes many people nervous these days.

As an example, maybe each service can have a separate, optional .env.sh file with contents like:

MYUID=$(id -u)
yyy_password=$(pass docker-compose/services/mssql)

a wrapper is then used to inject the dynamic env before invoking the real docker-compose? This probably means that a gpg passphrase will be needed once for server.sh xxx operation every so often?

# docker-compose-wrapper file
##########
function compose_wrapper() {
    if [ -f "../../.usewrapper" ]; then 
      set -a
      [-f ".env.sh"] && source <(cat .env.sh )
      set +a
    fi
    $real_compose  "$@"
}
...

compose_wrapper "$@"
##############

Request and more images to add

please add these for raspberry pi ubuntu 22.04 LTS

Request: if you can also make a script so that it download the source code and runs

sudo docker build --tag $project_name:$dockerfile_name .

Why do this? docker tagging system sometimes doesn't know the platform to build on or the developer has not updated the image yet for raspberry pi ubuntu [22.04 LTS]

~~1. mosquitto used for notifications~~XMPP is better and offers better options.
2. hapttic used for remote code execution on different systems
3. docpht use for bookmarking and saving code
4. immich used for back up of pictures and videos instead of nextcloud and similar services that take too long.