diff --git a/.github/assets/logo.png b/.github/assets/logo.png new file mode 100644 index 0000000..b1b6d22 Binary files /dev/null and b/.github/assets/logo.png differ diff --git a/README.md b/README.md index bbde789..4e8d811 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +

+ Gitea Mirror Logo +

+

@@ -16,11 +20,18 @@ ## 🚀 Quick Start ```bash +# Using Docker (recommended for most users) docker compose --profile production up -d -# or + +# Using Bun directly bun run setup && bun run dev + +# Using LXC container on Proxmox (for homelab setups) +curl -fsSL https://raw.githubusercontent.com/arunavo4/gitea-mirror/main/scripts/gitea-mirror-lxc-installer.sh | bash ``` +See the [LXC Container Deployment Guide](scripts/README-lxc.md) for detailed instructions on deploying with Proxmox LXC containers. +

Dashboard

@@ -159,6 +170,24 @@ docker compose --profile production up -d See [Docker build documentation](./scripts/README-docker.md) for more details. +##### Using LXC Containers (for Proxmox Homelab Setups) + +Gitea Mirror can be deployed on Proxmox LXC containers, which is ideal for homelab setups: + +```bash +# One-command installation on an Ubuntu 22.04 LXC container +curl -fsSL https://raw.githubusercontent.com/arunavo4/gitea-mirror/main/scripts/gitea-mirror-lxc-installer.sh | bash +``` + +The installer script: +- Downloads the Gitea Mirror repository +- Installs all dependencies including Bun +- Builds the application +- Sets up a systemd service +- Starts the application + +See the [LXC Container Deployment Guide](scripts/README-lxc.md) for detailed instructions. + ##### Building Your Own Image For manual Docker builds (without the helper script): @@ -357,6 +386,7 @@ docker compose -f docker-compose.dev.yml up -d - **Backend**: Bun - **Database**: SQLite (handles both data storage and event notifications) - **API Integration**: GitHub API (Octokit), Gitea API +- **Deployment Options**: Docker containers, Proxmox LXC containers ## Contributing