Merge pull request #53 from indrazm/feat/improve-docs-1

update docker, api and documentation

Author: indrazm

apps/api/src/api/account/api.py

@@ -1,6 +1,7 @@
 import jwt
 from fastapi import APIRouter, Depends, HTTPException, status
 from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer
+from sqlalchemy.exc import IntegrityError
 from sqlalchemy.orm import joinedload
 from sqlmodel import Session
 
@@ -82,15 +83,37 @@ def get_account(
 
     # Create user settings if they don't exist (for existing users)
     if not user_with_data.user_settings:
-        user_settings = UserSettings(user_id=user_with_data.id, is_onboarded=False)
-        db.add(user_settings)
-        db.commit()
+        try:
+            user_settings = UserSettings(user_id=user_with_data.id, is_onboarded=False)
+            db.add(user_settings)
+            db.commit()
+        except IntegrityError:
+            # Handle race condition - another request already created the settings
+            db.rollback()
+            # Re-load the user to get the newly created settings
+            user_with_data = (
+                db.query(User)
+                .options(joinedload(User.user_settings), joinedload(User.user_social))
+                .filter(User.id == current_user.id)
+                .first()
+            )
 
     # Create user social if they don't exist (for existing users)
     if not user_with_data.user_social:
-        user_social = UserSocial(user_id=user_with_data.id)
-        db.add(user_social)
-        db.commit()
+        try:
+            user_social = UserSocial(user_id=user_with_data.id)
+            db.add(user_social)
+            db.commit()
+        except IntegrityError:
+            # Handle race condition - another request already created the social data
+            db.rollback()
+            # Re-load the user to get the newly created social data
+            user_with_data = (
+                db.query(User)
+                .options(joinedload(User.user_settings), joinedload(User.user_social))
+                .filter(User.id == current_user.id)
+                .first()
+            )
 
     # Refresh to get the newly created relationships
     db.refresh(user_with_data)

docker-compose.yml

@@ -9,7 +9,7 @@ services:
     # ports:
     #   - "5432:5432"  # Commented out for production - no external access
     volumes:
-      - postgres_data:/var/lib/postgresql/data
+      - opencircle_pg_data:/var/lib/postgresql/data
     healthcheck:
       test: ["CMD-SHELL", "pg_isready -U ${POSTGRES_USER:-postgres}"]
       interval: 10s
@@ -25,7 +25,7 @@ services:
     # ports:
     #   - "6379:6379"  # Commented out for production - no external access
     volumes:
-      - redis_data:/data
+      - opencircle_redis_data:/data
     healthcheck:
       test: ["CMD", "redis-cli", "ping"]
       interval: 10s
@@ -146,9 +146,9 @@ services:
       - opencircle-network
 
 volumes:
-  postgres_data:
+  opencircle_pg_data:
     driver: local
-  redis_data:
+  opencircle_redis_data:
     driver: local
 
 networks:

docs/www/pages/platform-setup.mdx

@@ -7,7 +7,10 @@ Once you've deployed OpenCircle using Docker, follow these steps to set up your
 ## Access the Admin Panel
 
 1. Navigate to your admin dashboard: **http://localhost:4000** (or your configured `ADMIN_URL`)
-2. Log in with your admin credentials
+2. Create an Admin Account, Remember that register form is only shown once.
+
+![OpenCircle Platform](/admin/step-1.png)
+
 
 ## Create Your First Channel
 
@@ -57,4 +60,3 @@ Create additional channels for different purposes:
 - Verify database is running and accessible
 - Check authentication settings in Admin → Core Admin → Auth
 - Review API logs: `docker compose logs api`
-

docs/www/pages/self-hosting.mdx

@@ -23,9 +23,44 @@ Access your applications:
 - **Admin Dashboard**: http://localhost:4000
 - **API**: http://localhost:8000
 
+## Install Docker
+
+### macOS
+```bash
+# Install Docker Desktop using Homebrew
+brew install --cask docker
+
+# Or download from https://docker.com/products/docker-desktop
+```
+
+### Ubuntu/Debian
+```bash
+# Install Docker
+curl -fsSL https://get.docker.com -o get-docker.sh
+sudo sh get-docker.sh
+
+# Add your user to the docker group
+sudo usermod -aG docker $USER
+
+# Install Docker Compose
+sudo apt-get update
+sudo apt-get install docker-compose-plugin
+
+# Log out and back in for group changes to take effect
+```
+
+### Windows
+Download and install Docker Desktop from [docker.com](https://docker.com/products/docker-desktop)
+
+### Verify Installation
+```bash
+docker --version
+docker compose version
+```
+
 ## Prerequisites
 
-- Docker and Docker Compose installed
+- Docker and Docker Compose installed (see installation guide above)
 - At least 2GB RAM available
 - 10GB free disk space