Compare commits

...

2 commits

Author SHA1 Message Date
93d46acc6b Favicon & Strings 2024-01-09 23:07:50 +01:00
55fb5560fd Initial Ansible Docs 2024-01-09 23:07:43 +01:00
14 changed files with 251 additions and 18 deletions

View file

@ -1,4 +1,14 @@
+++
title = 'Ansible'
date = 2024-01-09T19:48:22+01:00
next = "/docs/ansible/core"
+++
The documentation for our Ansible Roles and Playbooks.
{{< cards >}}
{{< card link="/docs/ansible/core" title="Ansible: Core" subtitle="Core automation utilities that are used in the deployment of various Lunivity Circle Services." icon="cog" >}}
{{< card link="/docs/ansible/common" title="Ansible: Common" subtitle="Core automation utilities that are used in the deployment of various Lunivity Circle Services." icon="user-group" >}}
{{< card link="/docs/ansible/services" title="Ansible: Services" subtitle="Collection of roles and playbooks directly used to deploy a Lunivity Circle Service." icon="server" >}}
{{< /cards >}}

View file

@ -1,5 +0,0 @@
+++
title = 'Ansible: Common'
linkTitle = 'Common'
date = 2024-01-09T19:49:13+01:00
+++

View file

@ -0,0 +1,92 @@
+++
title = 'Ansible: Common'
linkTitle = 'Common'
date = 2024-01-09T19:49:13+01:00
next = "/docs/ansible/services"
prev = "/docs/ansible/core"
weight = 2
+++
{{< callout type="warning" >}}
**Note**: The documentation for this collection may currently be incomplete or even out of date. This collection is still a WIP, expect bugs and other issues arising.
{{< /callout >}}
## Introduction
This collection includes `common` automation utilities that are used in the deployment of various Lunivity Circle Services.<br>
Common utilities include any kinds of roles and playbooks that are responsible for the initial setup of a host.
## Getting Started
### Dependencies
Before you begin, ensure you have the following prerequisites:
- `Ansible` installed on your ansible host.
### Installation
{{< tabs items="CLI,requirements.yml" >}}
{{< tab >}}
**Using Command Line Interface (CLI):**
```bash
# install collection from source
$ ansible-galaxy collection install git+https://gitpot.dev/lunivity/ansible-common.git
# install collection from tagged release 1.0.0 (currently unavailable)
$ ansible-galaxy collection install git+https://gitpot.dev/lunivity/ansible-common.git,1.0.0
```
{{< /tab >}}
{{< tab >}}
**Using a** `requirements.yml` **File:**
1. Create a file named `requirements.yml` in your workspace.
2. Add the following content to your `requirements.yml` file:
```yaml
collections:
- name: https://gitpot.dev/lunivity/ansible-common.git
type: git
version: latest
```
- Install the collection by running the following command in your workspace:
```bash
ansible-galaxy collection install -r /path/to/requirements.yml
```
{{< /tab >}}
{{< /tabs >}}
### Usage
- To use the collection in your Ansible playbooks, include it like this:
```yaml
---
- name: Example Playbook
hosts: localhost
tasks:
- name: Include role from Lunivity
import_role:
name: lunivity.common.<role>
```
## Advanced Usage
There are multiple roles included in this collection. To view their advanced usage options, visit one of the cards below.
## Repository
You can find this project's repository [here](https://gitpot.dev/lunivity/ansible-core).
### Contributions
You're welcome to contribute to this website if you have a Lunivity account (see Gitpot's [homepage](https://gitpot.dev) for details if registrations aren't open yet).
### License
This project is licensed under the [GNU General Public License v3.0 (GPL-3.0)](./LICENSE.md). Refer to the [LICENSE](./LICENSE.md) file for more details.

View file

@ -1,5 +0,0 @@
+++
title = 'Ansible: Core'
linkTitle = 'Core'
date = 2024-01-09T19:48:35+01:00
+++

View file

@ -0,0 +1,92 @@
+++
title = 'Ansible: Core'
linkTitle = 'Core'
date = 2024-01-09T19:48:35+01:00
next = "/docs/ansible/common"
prev = "/docs/ansible"
weight = 1
+++
{{< callout type="warning" >}}
**Note**: The documentation for this collection may currently be incomplete or even out of date. This collection is still a WIP, expect bugs and other issues arising.
{{< /callout >}}
## Introduction
This collection includes `core` automation utilities that are used in the deployment of various Lunivity Circle Services.<br>
Core utilities include any kinds of roles and playbooks that are responsible for installing dependencies for services, or other general automations.
## Getting Started
### Dependencies
Before you begin, ensure you have the following prerequisites:
- `Ansible` installed on your ansible host.
### Installation
{{< tabs items="CLI,requirements.yml" >}}
{{< tab >}}
**Using Command Line Interface (CLI):**
```bash
# install collection from source
$ ansible-galaxy collection install git+https://gitpot.dev/lunivity/ansible-core.git
# install collection from tagged release 1.0.0 (currently unavailable)
$ ansible-galaxy collection install git+https://gitpot.dev/lunivity/ansible-core.git,1.0.0
```
{{< /tab >}}
{{< tab >}}
**Using a** `requirements.yml` **File:**
1. Create a file named `requirements.yml` in your workspace.
2. Add the following content to your `requirements.yml` file:
```yaml
collections:
- name: https://gitpot.dev/lunivity/ansible-core.git
type: git
version: latest
```
- Install the collection by running the following command in your workspace:
```bash
ansible-galaxy collection install -r /path/to/requirements.yml
```
{{< /tab >}}
{{< /tabs >}}
### Usage
- To use the collection in your Ansible playbooks, include it like this:
```yaml
---
- name: Example Playbook
hosts: localhost
tasks:
- name: Include role from Lunivity
import_role:
name: lunivity.core.<role>
```
## Advanced Usage
There are multiple roles included in this collection. To view their advanced usage options, visit one of the cards below.
## Repository
You can find this project's repository [here](https://gitpot.dev/lunivity/ansible-core).
### Contributions
You're welcome to contribute to this website if you have a Lunivity account (see Gitpot's [homepage](https://gitpot.dev) for details if registrations aren't open yet).
### License
This project is licensed under the [GNU General Public License v3.0 (GPL-3.0)](./LICENSE.md). Refer to the [LICENSE](./LICENSE.md) file for more details.

View file

@ -0,0 +1,11 @@
+++
title = 'Ansible: Services'
linkTitle = 'Services'
date = 2024-01-09T22:39:54+01:00
prev = "/docs/ansible/common"
weight = 3
+++
{{< callout type="warning" >}}
**Note**: The documentation for this collection may currently be incomplete or even out of date. This collection is still a WIP, expect bugs and other issues arising.
{{< /callout >}}

View file

@ -0,0 +1,4 @@
+++
title = 'SSH'
date = 2024-01-09T22:08:21+01:00
+++

View file

@ -1,4 +1,12 @@
+++
title = 'Services'
linkTitle = 'Services'
date = 2024-01-09T19:51:47+01:00
+++
Documentation for our deployed Services
{{< cards >}}
{{< card link="/services/authentik" title="Authentik" subtitle="Your one stop shop all things Login!" icon="user" >}}
<!-- {{< card link="/" title="No Icon" >}} -->
{{< /cards >}}

View file

@ -0,0 +1,4 @@
+++
title = 'Authentik'
date = 2024-01-09T22:07:42+01:00
+++

View file

@ -1,14 +1,14 @@
backToTop: "Scroll to top"
changeLanguage: "Change language"
changeTheme: "Change theme"
copyCode: "Copy code"
copyright: "© 2024 Lunivity"
changeLanguage: "🌐 Change language"
copyCode: "📋 Copy code"
changeTheme: "🎨 Change theme"
dark: "Dark"
editThisPage: "Edit this page on Gitpot →"
lastUpdated: "Last updated on"
light: "Light"
editThisPage: "✏️ Edit this page on Gitpot →"
lastUpdated: "Last updated on"
noResultsFound: "No results found."
onThisPage: "On this page"
poweredBy: "Powered by Hextra"
poweredBy: "Powered by Hugo and Hextra"
readMore: "Read more →"
searchPlaceholder: "Search..."
searchPlaceholder: "Search the universe..."
copyright: "© 2024 Lunivity"

BIN
static/apple-touch-icon.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
static/favicon-16x16.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 686 B

BIN
static/favicon-32x32.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

22
static/favicon-dark.svg Normal file
View file

@ -0,0 +1,22 @@
<svg width="674" height="674" viewBox="0 0 674 674" fill="none" xmlns="http://www.w3.org/2000/svg">
<rect width="674" height="674" rx="337" fill="url(#paint0_linear_602_35)"/>
<g filter="url(#filter0_d_602_35)">
<path fill-rule="evenodd" clip-rule="evenodd" d="M349.409 157.551C349.511 157.675 349.607 157.802 349.699 157.933C352.12 161.393 348.735 165.307 345.78 168.724C345.347 169.225 344.923 169.714 344.529 170.19C315.196 205.564 284.712 273.012 347.785 333.714C409.785 386.714 472.785 355.214 491.285 339.214C504.09 328.139 520.785 316.214 520.785 339.214C520.785 390.214 486.578 468.754 421.285 500.714C329.285 545.747 244.285 503.214 215.785 477.214C157.285 423.846 139.785 339.214 162.785 277.714C192.417 204.866 256.471 153.245 336.181 154.008C336.427 154.011 336.676 154.013 336.926 154.014C341.477 154.047 346.566 154.084 349.409 157.551ZM263 250.214C261.404 275.214 268.1 328.914 306.5 369.714C319.667 384.047 362 413.314 426 415.714C434.833 414.881 446.483 414.171 431.5 428.714C389 469.964 311.5 489.214 244 425.214C209.723 392.714 188.106 310.214 243 250.214C250.167 242.381 264.2 231.414 263 250.214Z" fill="white"/>
</g>
<defs>
<filter id="filter0_d_602_35" x="137" y="142" width="399.785" height="398.458" filterUnits="userSpaceOnUse" color-interpolation-filters="sRGB">
<feFlood flood-opacity="0" result="BackgroundImageFix"/>
<feColorMatrix in="SourceAlpha" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 127 0" result="hardAlpha"/>
<feOffset dy="4"/>
<feGaussianBlur stdDeviation="8"/>
<feComposite in2="hardAlpha" operator="out"/>
<feColorMatrix type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.15 0"/>
<feBlend mode="normal" in2="BackgroundImageFix" result="effect1_dropShadow_602_35"/>
<feBlend mode="normal" in="SourceGraphic" in2="effect1_dropShadow_602_35" result="shape"/>
</filter>
<linearGradient id="paint0_linear_602_35" x1="111" y1="674" x2="782.717" y2="-77.5721" gradientUnits="userSpaceOnUse">
<stop stop-color="#759CFF"/>
<stop offset="1" stop-color="#78A1BB"/>
</linearGradient>
</defs>
</svg>

After

Width:  |  Height:  |  Size: 2 KiB