localhostings

Self-hosted applications in my local network

What's included 🗃️

1. nginx; serving multiple vhosts
2. postgres; for my personal projects
3. mattermost; open-source alternative to Slack

⚡ Getting started

# clone from github
git clone git@github.com:cednore/localhostings.git

# cd into repo directory
cd localhostings

# if you are @cednore, pump the secrets out from private submodule
git submodule update --init --recursive
git submodule set-branch --default secrets

# if not, then start from templates
rm -rf secrets && cp -R secrets.examples secrets

# kickstart everything
just up

🔨 Development scripts

just is an essential tool for this project, helping define and execute development scripts. To explore the range of available scripts, you can easily run just --list or refer to the justfile in the repository.

$ just --list
Available recipes:
    default # list available recipes
    down    # remove the services (but not the volumes)
    up      # kickstart all the services

🔒 Secret management

This repository contains infrastructure for my local web applications along with a git submodule that holds environment variables customized for them. To protect these sensitive variables, the git submodule repo is a private repository. This means that anyone interested in cloning this project may encounter an error while cloning the repository, as access to the submodule repository is restricted. The use of submodules allows me to manage these sensitive variables securely while maintaining the integrity of my project.

👋 Contributions

Contributions are welcome by opening issues and pull requests. See CONTRIBUTING.md file for detailed guidelines.

🚧 Roadmap

• Prerequisites chapter in README.md
• excalidraw
• inventree
• GitHub issue templates; bug, security, cost, feature and so on
• GitHub PR template
• Example of secrets dir, along with documentation explaining how to copy and customize

📄 License

This project is licensed under the MIT License.

🙇 Credits

• Thanks to gitmoji, I use it everyday.