From 730de49b1c3ef209c025767c5ef5c2fff7b63eb5 Mon Sep 17 00:00:00 2001
From: Kevin Veen-Birkenbach <kevin@veen.world>
Date: Thu, 29 Jun 2023 14:50:38 +0200
Subject: [PATCH] Optimized pixelfed README.md file with ChatGPT

---
 roles/server_docker-pixelfed/README.md | 46 +++++++++++++++++++-------
 1 file changed, 34 insertions(+), 12 deletions(-)

diff --git a/roles/server_docker-pixelfed/README.md b/roles/server_docker-pixelfed/README.md
index b90f4909..9150ded1 100644
--- a/roles/server_docker-pixelfed/README.md
+++ b/roles/server_docker-pixelfed/README.md
@@ -1,17 +1,27 @@
-# role server_docker-pixelfed
+# Pixelfed Docker Server Role
 
-## access application
+This README details the steps to manage your Pixelfed instance running in a Docker container. This setup is part of the server_docker-pixelfed role within Kevin Veen-Birkenbach's computer-playbook located at [this GitHub repository](https://github.com/kevinveenbirkenbach/computer-playbook/tree/master/roles/server_docker-pixelfed). 
+
+## Accessing Services
+
+### Application Access
+To gain shell access to the application container, run the following command:
 ```bash
 docker-compose exec -it application bash
 ```
 
-## access database
+### Database Access
+To access the MariaDB instance in the database container, run the following command:
 ```bash
 docker-compose exec -it database mariadb -u pixelfed -p
 ```
 
-## cleanup instagram imports
-### mysql
+## Instagram Import Cleanup
+
+If you have imported posts from Instagram, you can clean up the imported data and files as follows:
+
+### Database Cleanup
+Run these commands inside your MariaDB shell to remove import related data:
 ```bash
 DELETE from import_posts WHERE 1;
 DELETE from import_jobs WHERE 1;
@@ -19,19 +29,25 @@ DELETE from import_datas WHERE 1;
 DELETE from statuses where created_at < "2022-12-01 22:15:39";
 DELETE from media where deleted_at >= "2023-07-28 14:39:05";
 ```
-### files
+
+### File System Cleanup
+Run these commands to remove the imported files and trigger the cleanup job:
 ```bash
 docker-compose exec -u "www-data" application rm -rv "/var/www/storage/app/imports/1"
 docker-compose exec -u "www-data" application php artisan schedule:run
 ```
 
-## hard cleanup
+## Full Cleanup (Reset)
+
+For a hard reset, which will delete all data and stop all services, use the following commands:
 ```bash
 docker-compose down
 docker volume rm pixelfed_application_data pixelfed_database pixelfed_redis_data
 ```
 
-## update
+## Update Procedure
+
+To update your Pixelfed instance, navigate to the directory where your `docker-compose.yml` file is located and run these commands:
 ```bash 
 cd {{path_docker_compose_files}}pixelfed/ &&
 docker-compose down &&
@@ -41,13 +57,19 @@ docker-compose build &&
 docker-compose -p pixelfed up -d --force-recreate
 ```
 
-## inspect 
+## Inspecting the Services
 
+To see the status of all services or follow the logs, use these commands:
 ```bash
 docker-compose ps -a
 docker-compose logs -f
 ```
 
-## further information
-- https://hub.docker.com/r/zknt/pixelfed
-- https://blog.pixelfed.de/2020/05/29/pixelfed-in-docker/
\ No newline at end of file
+## Further Reading
+For additional information, refer to these resources:
+- [Docker image on Docker Hub](https://hub.docker.com/r/zknt/pixelfed)
+- [Blog Post about running Pixelfed in Docker](https://blog.pixelfed.de/2020/05/29/pixelfed-in-docker/)
+
+Author: Kevin Veen-Birkenbach, [https://www.veen.world](https://www.veen.world), [kevin@veen.world](mailto:kevin@veen.world)
+
+This README was optimized with the help of OpenAI's ChatGPT. You can view the conversation [here](https://chat.openai.com/share/3daea33f-2e30-46e9-a709-a9c93e823ed9).
\ No newline at end of file