swarm-cookbook
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.7%) to scientific vocabulary
Last synced: 6 months ago
·
JSON representation
·
Repository
Basic Info
- Host: GitHub
- Owner: ragdata-vault
- License: mit
- Language: Shell
- Default Branch: master
- Size: 4.07 MB
Statistics
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Created over 2 years ago
· Last pushed over 2 years ago
Metadata Files
Readme
License
Citation
Codeowners
README.md
[Swarm Cookbook v-0.1.0](https://github.com/ragdata/swarm-cookbook/releases/tag/v-0.1.0)
Issues 🔸 Documentation 🔸 Releases
Everything You Need to Create the Ultimate Self-Hosted Docker Swarm
#### _Elapsed Project Time_
[](https://wakatime.com/badge/user/7e04d9d4-3a44-495e-b622-69fdbafd036c/project/dba7a846-0fe5-4ea7-b59d-f2441cbe896c)
📖 Table of Contents
- [Project Overview](#-project-overview) - [What's Included?](#-whats-included) - [Installation](#-installation) - [Security](#-security) - [Available Support](#-available-support) - [Project Resources](#project-resources) - [Community Resources](#community-resources) - [Project Supporters](#-project-supporters) - [Author/Maintainer](#-author--maintainer) - [Contributors](#-contributors) - [Acknowledgements & Attributions](#-copyright--attributions) - [License](#-license) - [Resources](#-resources)
If you like this repository, please give it a ⭐ (it really does help)
## ⭐ [Project Overview](#toc)
### ❓ [What's Included?](#toc)
### 📂 [Installation](#toc)
While I plan to realease a version for the bash shell, this is not yet complete. So, to get the full functionality contained within the cookbook, you'll need to install the ZSH Shell, plus a few extras ...
#### Step 1 - Install ZSH + Extras
Under a bash shell:
```shell
sudo ./install.sh zsh
```
or
```shell
sudo bash -c './install.sh zsh'
```
#### Step 2 - Clone the Repo
Once you've got your new shell sorted, clone the repo ...
Via SSH:
```shell
git clone git@github.com:ragdata/swarm-cookbook
```
Via HTTPS:
```shell
git clone https://github.com/ragdata/swarm-cookbook
```
#### Step 3 - Run the Installer
Now, run the installer to setup each node with all the goodies provided by the cookbook ...
To install everything at once:
```shell
cd swarm-cookbook
sudo ./install.sh
```
**OR**, install one part at a time:
```shell
cd swarm-cookbook
sudo ./install.sh config
sudo ./install.sh dotfiles
sudo ./install.sh bin
sudo ./install.sh swarm
```
#### Step 4 - Run Node Setup Scripts
[`^ Top`](#toc)
## 🔐 [Security](#toc)
While I always follow good security practices, 100% security can never be guaranteed in any software package. The `Swarm Cookbook` is provided AS IS, and without warranty. You can find more details in the [LICENSE](LICENSE) file included with this repository.
If you discover any issue regarding the security of this project, please disclose that information responsibly by sending a [security advisory][advisory]. **PLEASE DO NOT CREATE AN ISSUE OR DISCUSSION TOPIC.** You can read more about this project's security policies [HERE][security]
[`^ Top`](#toc)
## 💪 [Available Support](#toc)
### 🔸Project Resources
- [Issues Register](https://github.com/ragdata/swarm-cookbook/issues)
- [Project Site](https://ragdata.github.io/swarm-cookbook)
### 🔸Community Resources
- [**The RedEyed Community Discord Server**](https://discord.gg/s6gZZUc67y)
- [Community Support Document](https://github.com/ragdata/.github/blob/master/.github/SUPPORT.md)
- [Community Governance Policy](https://github.com/ragdata/.github/blob/master/.github/GOVERNANCE.md)
- [Community Code of Conduct](https://github.com/ragdata/.github/blob/master/.github/CODE_OF_CONDUCT.md)
- [Community Standards](https://github.com/ragdata/swarm-cookbook/community)
- [Security Policy](https://github.com/ragdata/swarm-cookbook/security/policy)
- [Security Overview](https://github.com/ragdata/swarm-cookbook/security)
- [Security Advisories](https://github.com/ragdata/swarm-cookbook/security/advisories)
- [Dependabot Alerts](https://github.com/ragdata/swarm-cookbook/security/dependabot)
[`^ Top`](#toc)
## ❤️ [Project Supporters](#toc)
Many Thanks to JetBrains for Their Invaluable Support
 |
**JetBrains very generously provide me with a free license for their products every month, and you can get one too if you're working on a public, open-source project!** I've used JetBrains' IDEs for many years now, and was more than happy to pay for a license every year back when I was working in the corporate sector. **Absolutely my first choice in IDEs!** |
Click here to find out about available sponsorship opportunities!
If sponsorship isn't right for you, but you have found my work to be useful in some way,
would you please consider buying me a coffee to help keep me going?
[![Ragdata](https://img.shields.io/badge/-Darren_"Ragdata"_Poulton-d20000?style=for-the-badge&labelColor=555555&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABsAAAAgEAYAAACz+d94AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAZAAAAGQBeJH1SwAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAnKSURBVFiFtVlrbFTVE/+du7t3a7t3u7vdPhb6pyjFankUiSYWm1gTCsHEWBOpEhEViG9RawXCB1GpNUKaKAFqNFowFkVQxMgj4W2hjRRMlwYQpAil72633W633e7ee8//w3BY+oK2sfPl9JwzZ2Z+M3PmzN6Cc845B8ZrrKkBgOzss2cBoLq6uhoA5s8fb70SxonOnmWMseXLOQeAw4dpNSNDkgBg3z6xP176xw1YIAAAZWUEbNMmsU7zsjKjEQB+/HG89DMRutGS280YYxMnMgYAn35KY1SUpgHAyy/PmsU5552dgv/8ecYYS09PT+ec8/PnxfrFi4wxpiihEABs2UK22Gy6DgBvvUVyrl4dN2CVlYwxdtddFgsAvP8+ra5aRWN0dH/uc+dkGQAyMx96SFEmTnS5GJNlVX3jDc5DIaNx8+aqKr+/oaGpiQBVVtK5adP6y+npofGzz7q7AWDDhsxMzjnv7R0zMPKwLFMEXnqJVtesoXHSpKHF/fbbmTMmk8m0du2KFRaLw7FwIcAY8MordK0bGgCAsUmTaL209KOP/H6/f/v2nJxwuKfngw/IlieeGFp+XR2NRUUGAwCUllIGkHuGBEZALBZVBYAlS2h75UpKsZSUoRWdPUu+W7ly7lyHw+VKSWFM13W9oIBzxoCpU2/l5pxqI2MzZ940gHHO2KVLnEsSY8XFhw97vU1NdXVRUQCwfj1xzZgxUDM54No1mq1fT3f2u+8IaHc3o3L8+efE+OKLxBgbOzQQt5uAr1v36KM2W3y8onDOmCTl55MDBhsgKDMzHA4Gr1yprDSZoqLuuWc4PqILFwh0aen+/R0dzc11dVYrEMmYiGP6k89HOLZtY+TDri7aUBQadZ0Y9u07dUqWZXn79oICRbHb775b13UdeO454ktPv72BgM3Gua4DO3f6fB6Ppj37rNXqdBoM7e2SJI24Jp8/T9xlZevX+/1dXVevPvxwKNTbu2gROfTxx4lPSPT7bwATufu//xFjQcEjj8TFJSefOEEZfOAAwDljNttITRG0dGlvb3c3sGxZMBgIAN9+SwXom2+iomJiRisNoOTt7GQMMJkWLDhxwuttaJgzh/aKi2m8fv0GwkhZpkiZTJzruqbJ8lgB0UkgNzcUurWGPfVUMNjTA5jNY3tmhD2ccx4OGwwUCLO5P09Hxw1g9fWRYwBgtRqNgKb5fGNRDQDz5vX1BYNAXBwlryC7nVIzJycUCgbHKh0wmRiTpM5Oki2ukKD6eomAUAcHiCyNj1dVVTUaGxtplUrGSGjiRF3XNGDJEkq94eiFF2hf8I+OVFVVVbWnp6mJ5gkJYociWF1tJCBud/+0uO++rq6uroYGjyc21uFISmpoWLQoGAwEUlKmTtU0VQUSEigSTicZFh9PkYikGGOMAYqyYMGCBUAodPny5ctAVFRGRkYGAOzatWsX8NNPPp/HA/T1EX9bG2OSBHg8kmQwAK2tVDb++cdgMBqBH34wm2Ni6ut9Pp/P5/N6a2oYY+z++4XlIlA3IlZV1X8j0gGQmbW1R4/KclQUkJ6uquEwMGuWqoZCQHIyARt4ZxITCwsLC4FJk3bs2LEDsNuXLVu2DEhOLi0tLQVkecqUKVMi/OK8kCfkz5hB+srLTSZ62wCgtrZ/BAcCO31amjGDc86vXKHlc+dotNsvXGCMsZQUqkK1tU1N5MHXXlMUhwO4dMlgMJmGTxa/f8+ePXsAVW1vb28HmptXr169GgiH6+vr6wGrNTc3N3f481euUISEvuvXDQaDgUoH57W11dWMMTZ5srCXxpqamTM55/zffwe8JLt3i7/CYQDIyaEEO3NGrHu9lBqvv64odjtw6pTJRH1hfzIaXS6XC5Aks9lsBhIS1q5duxaQJIvFYgG6uw8ePHhw8Lm//jIaZRl49VUC1NY28L3TdcaqqqilmjdPrFKkfvlFzG8eIcaffxZzuoTz5xsMZjNw6NCtcAGgt5fuxKpVFovNBly7Rh6OKNI0TQM4D4fDYcDjKS4uLgZ0PRAIBABZnjx58mSAMYpEXR2df+89RbHZgECA5PcnVWVMlnX92DECMn/+TSDSMMCox6qupgMnT9JqTs7hw62tra1NTYxxzjk1YLdSKEROaGkhz5rNaWlpaYDNlpeXlwdIUkxMTAwgy6mpqalAR8e2bdu2ARMmbNy4cSNgMDgcDkfkvJA3kBjjHHC7jxxpa2tra2wknrlzabe8fPp0zkUvCgDGwQIAYMMGmv36K92jp58mr+zdS9GYPbs/P5CWpqqqCkhSdHR0NNDaWlRUVAQ0N69Zs2ZN5G4Fg2632w309FRUVFQAqtrW1tYGpKVRNRTyBj7eui5JjP3+O6X9M8/QqtVKfMLeW3AM/tnCGGOSRLE5d44UeTxz5jidEyYsXw5omqa53cRrNot3SJTtgSQeZyo+fX0ul65rmtk8XJ+Ylxcb63QCDQ1UrIhCIc4ZY+yBByoqvN7m5q+/pnW7ndru6dOpfkdagSHE38qQn0+gs7JOnPB4GhttNsYAzo8dE9yi/A8kUQSWLrVa4+LI4Li4ixcXL6b5n38OXXQGyiN9R46cPOn1NjdTjw/MmUN25ecPBHQbYET0DOzfL6oNRa6wUJI4B778Ujhh2jQypLWVPLxuXUxMbCywYgVVTfGwChJFJj/fYrHbgZUrqfg0NtJ5Ie+mgRLnjJWUkP5PPqHVnTuprB84MJz9g+7YIOQSALzzDgGsqTl+vLOztdXvz8qy2RITjx+vqjKZZDk7u6SEunbRQYyUTp40mcxm4PRpq1WWgQcfpIeZ6OjR8vLOzpaWYJD0z55NsZk+/Y5234mBqs316yT4+efJ6E2bqJktKSHDdH20gAaSOE/yNC02VtfD4c2bSe/GjSR78eKMjMgnhtvRqL9SUW/28cc0i4nJyrLbExNdLpKxaNHtzg71aWBo+v77ioqOjpaW9naS6/XS1RB670yj/q5IVejDD2mWlFRYGAj4fHv30jVvbh6tvAjRa7huXXe3z3fwIAGKiyN9hYWjlTaGD6ZUhf7+GwCWLMnODoWCwczM9HRV7evbsoV4Blep25Om3XuvpoVCX3zx2GPhcDCYmdneDtDXsaGr3p1ozF+CFy7knHNNI4Bvv/3VV11dnZ2aFh3Nua5v3TpSOcRfWrp1q8/X0QFcvAgAb76Znc055yP/HTiI/ut/Bhw6BBiNc+c6HHZ7QkJ5uaLY7YmJnCuK3Z6Q4HaLOe0fP/7HHwDw5JP/tR3j9t+Od981m63W1FSr1WZLSiKACQlut9VqtycmVlYuXaooipKWNl76xw2YGJ1Op9PpdLkUJS7O5dq9Oz4+Pj4+PilpvPX+H9FzAjWyi5ldAAAAAElFTkSuQmCC)](https://github.com/Ragdata)
### [Join me & the RedEyed Community!](https://discord.gg/s6gZZUc67y)
[](https://discord.gg/s6gZZUc67y)
[`^ Top`](#toc)
## 💎 [Contributors](#toc)
[](.github/CONTRIBUTORS.md)
If you'd like to make a contribution, then please see the [**Swarm Cookbook Contributor's Guide**][contributing]
It's not just contributions of code that I'm looking for. If you have any ideas or suggestions about how this project may be improved, don't hesitate to [open an issue][issues] and let me know! Contributions of ALL kinds will be recognised here if they are made part of this project - thanks to the [All-Contributors][all-contributors] bot.
[**VIEW ALL PROJECT CONTRIBUTORS**](.github/CONTRIBUTORS.md)
[`^ Top`](#toc)
## ©️ [Acknowledgements & Attributions](#toc)
As with most open-source projects, this one could not have happened without the work of those who preceded us. [**View Acknowledgements & Attributions**](ACKNOWLEDGEMENTS.md)
>
[](https://discord.gg/s6gZZUc67y)
"We see much further, and reach much higher,
> because we stand upon the shoulders of giants"
[`^ Top`](#toc)
## ⚖️ [License](#toc)
Copyright © 2023 Darren (Ragdata) Poulton
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
[`^ Top`](#toc)
## 📖 [Resources](#toc)
[`^ Top`](#toc)
If you like this repository, please give it a ⭐ (it really does help)
Owner
- Name: Ragdata's Vault
- Login: ragdata-vault
- Kind: organization
- Email: ragdata@users.noreply.github.com
- Location: Australia
- Website: https://ragdata.net
- Twitter: RagdataAU
- Repositories: 1
- Profile: https://github.com/ragdata-vault
A holding space for spring cleaning
Citation (CITATION.cff)
# See: https://citation-file-format.github.io/
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: Swarm Cookbook
message: >-
If you use this software, please cite using the
information provided here
type: software
authors:
- given-names: Darren
family-names: Poulton
email: ragdata@ragdata.dev
orcid: 'https://orcid.org/0000-0001-8986-2886'
affiliation: Redeyed Software
repository-code: 'https://github.com/ragdata/swarm-cookbook'
url: 'https://ragdata.github.io/swarm-cookbook'
abstract: >-
A collection of scripts, actions, and workflows to help you keep your GitHub repositories in order
license: MIT
GitHub Events
Total
Last Year
Dependencies
src/stacks/traefik-cloudflare/docker-compose.yml
docker
- traefik 2.10
src/stacks/traefik-local/docker-compose.yml
docker
- traefik v2.10
src/stacks/traefik-mkcert/docker-compose.yml
docker
- traefik v2.10