mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-29 15:06:26 +02:00
Optimized descriptions, README.md's and meta/main.yml's for portfolio and sphinx docs
This commit is contained in:
@@ -1,13 +1,32 @@
|
||||
# 🚀 Docker Mastodon with OIDC Support
|
||||
# Mastodon
|
||||
|
||||
## Description
|
||||
|
||||
Dive into a decentralized social experience with Mastodon, a vibrant platform that redefines online communication with its federated, community-driven approach. With a rich set of features focused on privacy, scalability, and customization, Mastodon empowers users to create, share, and interact in an open social network.
|
||||
|
||||
## Overview
|
||||
This project provides a **Docker-based setup for Mastodon**, including full **OIDC (OpenID Connect) authentication support**. It is maintained by **[Kevin Veen-Birkenbach](https://www.veen.world)**.
|
||||
|
||||
## Credits 📝
|
||||
This role deploys Mastodon using Docker, streamlining the installation and configuration of a full-featured social networking platform. Mastodon is built to support federation across multiple instances, offering robust content moderation, real-time updates, and flexible API integrations. Its advanced architecture—including separate services for the web frontend, streaming API, and background job processing—ensures high performance and scalability for large communities.
|
||||
|
||||
This README and some parts of the code were created with the assistance of ChatGPT. You can follow the discussion and evolution of this project in [this conversation](https://chatgpt.com/c/67a4e19b-3884-800f-9d45-621dda2a6572).
|
||||
For detailed configuration and operational instructions, please refer to the following files in this directory:
|
||||
- [Installation.md](./Installation.md)
|
||||
- [Administration.md](./Administration.md)
|
||||
- [Upgrade.md](./Upgrade.md)
|
||||
- [User_Administration.md](./User_Administration.md)
|
||||
|
||||
## Other Resources
|
||||
## Features
|
||||
|
||||
- **Decentralized Network:** Connect with users across multiple instances in a federated social media ecosystem.
|
||||
- **Real-Time Streaming:** Enjoy dynamic updates and real-time content delivery through dedicated streaming services.
|
||||
- **Robust Content Moderation:** Utilize powerful moderation tools to manage community interactions and maintain safe spaces.
|
||||
- **Scalable Architecture:** Benefit from a multi-service, Docker-based setup that supports high user loads and seamless background processing.
|
||||
- **Flexible Authentication:** Integrated support for OpenID Connect (OIDC) simplifies user login and enhances security.
|
||||
- **Customizable User Experience:** Configure themes, timeline settings, and notification options to tailor the social experience to your community.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Mastodon Official Website](https://joinmastodon.org/)
|
||||
- [Mastodon Documentation](https://docs.joinmastodon.org/)
|
||||
- [Mastodon with Docker & Traefik](https://goneuland.de/mastodon-mit-docker-und-traefik-installieren/)
|
||||
- [Mastodon Configuration Guide](https://gist.github.com/TrillCyborg/84939cd4013ace9960031b803a0590c4)
|
||||
- [Check Website Availability](https://www.2daygeek.com/linux-command-check-website-is-up-down-alive/)
|
||||
@@ -15,5 +34,12 @@ This README and some parts of the code were created with the assistance of ChatG
|
||||
- [Scaling a Mastodon Server](https://www.digitalocean.com/community/tutorials/how-to-scale-your-mastodon-server)
|
||||
- [Mastodon GitHub Issues](https://github.com/mastodon/mastodon/issues/7958)
|
||||
|
||||
## Credits
|
||||
|
||||
Developed and maintained by **Kevin Veen-Birkenbach**.
|
||||
Learn more at [veen.world](https://www.veen.world).
|
||||
|
||||
Part of the [CyMaIS Project](https://github.com/kevinveenbirkenbach/cymais)
|
||||
Licensed under [CyMaIS NonCommercial License (CNCL)](https://s.veen.world/cncl).
|
||||
|
||||
|
||||
|
22
roles/docker-mastodon/meta/main.yml
Normal file
22
roles/docker-mastodon/meta/main.yml
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
galaxy_info:
|
||||
author: "Kevin Veen-Birkenbach"
|
||||
description: "Dive into a decentralized social experience with Mastodon, a federated platform designed for dynamic, community-driven networking. Enjoy real-time updates, robust moderation, and customizable user interfaces that empower communities to thrive."
|
||||
license: "CyMaIS NonCommercial License (CNCL)"
|
||||
license_url: "https://s.veen.world/cncl"
|
||||
company: |
|
||||
Kevin Veen-Birkenbach
|
||||
Consulting & Coaching Solutions
|
||||
https://www.veen.world
|
||||
galaxy_tags:
|
||||
- mastodon
|
||||
- docker
|
||||
- social networking
|
||||
- federated
|
||||
- decentralized
|
||||
repository: "https://s.veen.world/cymais"
|
||||
issue_tracker_url: "https://s.veen.world/cymaisissues"
|
||||
documentation: "https://s.veen.world/cymais"
|
||||
logo:
|
||||
class: "fa-solid fa-bullhorn"
|
||||
dependencies: []
|
Reference in New Issue
Block a user