feat: docker and readme
This commit is contained in:
4 files changed
+338
-12
No files matched your search
+134
@@ -0,0 +1,134 @@
|
|||||||
|
############################################################
|
||||||
|
# Production-ready .dockerignore for a Next.js (Vercel-style) app
|
||||||
|
# Keeps Docker builds fast, lean, and free of development files.
|
||||||
|
############################################################
|
||||||
|
|
||||||
|
# Dependencies (installed inside Docker, never copied)
|
||||||
|
node_modules/
|
||||||
|
.pnpm-store/
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
# Next.js build outputs (always generated during `next build`)
|
||||||
|
.next/
|
||||||
|
out/
|
||||||
|
dist/
|
||||||
|
build/
|
||||||
|
.vercel/
|
||||||
|
|
||||||
|
# Tests and testing output (not needed in production images)
|
||||||
|
coverage/
|
||||||
|
.nyc_output/
|
||||||
|
__tests__/
|
||||||
|
__mocks__/
|
||||||
|
jest/
|
||||||
|
cypress/
|
||||||
|
cypress/screenshots/
|
||||||
|
cypress/videos/
|
||||||
|
playwright-report/
|
||||||
|
test-results/
|
||||||
|
.vitest/
|
||||||
|
vitest.config.*
|
||||||
|
jest.config.*
|
||||||
|
cypress.config.*
|
||||||
|
playwright.config.*
|
||||||
|
*.test.*
|
||||||
|
*.spec.*
|
||||||
|
|
||||||
|
# Local development and editor files
|
||||||
|
.git/
|
||||||
|
.gitignore
|
||||||
|
.gitattributes
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
*.log
|
||||||
|
|
||||||
|
# Environment variables (only commit template files)
|
||||||
|
.env
|
||||||
|
.env*.local
|
||||||
|
.env.development
|
||||||
|
.env.test
|
||||||
|
.env.production.local
|
||||||
|
|
||||||
|
# Docker configuration files (not needed inside build context)
|
||||||
|
Dockerfile*
|
||||||
|
.dockerignore
|
||||||
|
compose.yaml
|
||||||
|
compose.yml
|
||||||
|
docker-compose*.yaml
|
||||||
|
docker-compose*.yml
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
*.md
|
||||||
|
docs/
|
||||||
|
|
||||||
|
# CI/CD configuration files
|
||||||
|
.github/
|
||||||
|
.gitlab-ci.yml
|
||||||
|
.travis.yml
|
||||||
|
.circleci/
|
||||||
|
Jenkinsfile
|
||||||
|
|
||||||
|
# Cache directories and temporary data
|
||||||
|
.cache/
|
||||||
|
.parcel-cache/
|
||||||
|
.eslintcache
|
||||||
|
.stylelintcache
|
||||||
|
.swc/
|
||||||
|
.turbo/
|
||||||
|
.tmp/
|
||||||
|
.temp/
|
||||||
|
|
||||||
|
# TypeScript build metadata
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# Sensitive or unnecessary configuration files
|
||||||
|
*.pem
|
||||||
|
.editorconfig
|
||||||
|
.prettierrc*
|
||||||
|
prettier.config.*
|
||||||
|
.eslintrc*
|
||||||
|
eslint.config.*
|
||||||
|
.stylelintrc*
|
||||||
|
stylelint.config.*
|
||||||
|
.babelrc*
|
||||||
|
*.iml
|
||||||
|
*.ipr
|
||||||
|
*.iws
|
||||||
|
|
||||||
|
# OS-specific junk
|
||||||
|
.DS_Store
|
||||||
|
._*
|
||||||
|
.Spotlight-V100
|
||||||
|
.Trashes
|
||||||
|
ehthumbs.db
|
||||||
|
Thumbs.db
|
||||||
|
Desktop.ini
|
||||||
|
|
||||||
|
# AI/ML tool metadata and configs
|
||||||
|
.cursor/
|
||||||
|
.cursorrules
|
||||||
|
.copilot/
|
||||||
|
.copilotignore
|
||||||
|
.github/copilot/
|
||||||
|
.gemini/
|
||||||
|
.anthropic/
|
||||||
|
.kiro
|
||||||
|
.claude
|
||||||
|
AGENTS.md
|
||||||
|
.agents/
|
||||||
|
|
||||||
|
# AI-generated temp files
|
||||||
|
*.aider*
|
||||||
|
*.copilot*
|
||||||
|
*.chatgpt*
|
||||||
|
*.claude*
|
||||||
|
*.gemini*
|
||||||
|
*.openai*
|
||||||
|
*.anthropic*
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
name: Docker Image CI
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_dispatch:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build-and-push:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout repository
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Log in to Gitea Container Registry
|
||||||
|
uses: docker/login-action@v3
|
||||||
|
with:
|
||||||
|
registry: git.abunchofknowitalls.com
|
||||||
|
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||||
|
password: ${{ secrets.REGISTRY_TOKEN }}
|
||||||
|
|
||||||
|
- name: Extract metadata for Docker
|
||||||
|
id: meta
|
||||||
|
uses: docker/metadata-action@v5
|
||||||
|
with:
|
||||||
|
images: git.abunchofknowitalls.com/${{ gitea.repository }}
|
||||||
|
|
||||||
|
- name: Build and push Docker image
|
||||||
|
uses: docker/build-push-action@v5
|
||||||
|
with:
|
||||||
|
context: .
|
||||||
|
push: true
|
||||||
|
tags: ${{ steps.meta.outputs.tags }}
|
||||||
|
labels: ${{ steps.meta.outputs.labels }}
|
||||||
+114
@@ -0,0 +1,114 @@
|
|||||||
|
# ============================================
|
||||||
|
# Stage 1: Dependencies Installation Stage
|
||||||
|
# ============================================
|
||||||
|
|
||||||
|
# IMPORTANT: Node.js Version Maintenance
|
||||||
|
# This Dockerfile uses Node.js 24.13.0-slim, which was the latest LTS version at the time of writing.
|
||||||
|
# To ensure security and compatibility, regularly update the NODE_VERSION ARG to the latest LTS version.
|
||||||
|
ARG NODE_VERSION=24.13.0-slim
|
||||||
|
|
||||||
|
FROM node:${NODE_VERSION} AS dependencies
|
||||||
|
|
||||||
|
# Set working directory
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# Copy package-related files first to leverage Docker's caching mechanism
|
||||||
|
COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* .npmrc* ./
|
||||||
|
|
||||||
|
# Install project dependencies with frozen lockfile for reproducible builds
|
||||||
|
RUN --mount=type=cache,target=/root/.npm \
|
||||||
|
--mount=type=cache,target=/usr/local/share/.cache/yarn \
|
||||||
|
--mount=type=cache,target=/root/.local/share/pnpm/store \
|
||||||
|
if [ -f package-lock.json ]; then \
|
||||||
|
npm ci --no-audit --no-fund; \
|
||||||
|
elif [ -f yarn.lock ]; then \
|
||||||
|
corepack enable yarn && yarn install --frozen-lockfile --production=false; \
|
||||||
|
elif [ -f pnpm-lock.yaml ]; then \
|
||||||
|
corepack enable pnpm && pnpm install --frozen-lockfile; \
|
||||||
|
else \
|
||||||
|
echo "No lockfile found." && exit 1; \
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# Stage 2: Build Next.js application in standalone mode
|
||||||
|
# ============================================
|
||||||
|
|
||||||
|
FROM node:${NODE_VERSION} AS builder
|
||||||
|
|
||||||
|
# Set working directory
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# Copy project dependencies from dependencies stage
|
||||||
|
COPY --from=dependencies /app/node_modules ./node_modules
|
||||||
|
|
||||||
|
# Copy application source code
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
ENV NODE_ENV=production
|
||||||
|
|
||||||
|
# Next.js collects completely anonymous telemetry data about general usage.
|
||||||
|
# Learn more here: https://nextjs.org/telemetry
|
||||||
|
# Uncomment the following line in case you want to disable telemetry during the build.
|
||||||
|
# ENV NEXT_TELEMETRY_DISABLED=1
|
||||||
|
|
||||||
|
# Build Next.js application
|
||||||
|
# If you want to speed up Docker rebuilds, you can cache the build artifacts
|
||||||
|
# by adding: --mount=type=cache,target=/app/.next/cache
|
||||||
|
# This caches the .next/cache directory across builds, but it also prevents
|
||||||
|
# .next/cache/fetch-cache from being included in the final image, meaning
|
||||||
|
# cached fetch responses from the build won't be available at runtime.
|
||||||
|
RUN if [ -f package-lock.json ]; then \
|
||||||
|
npm run build; \
|
||||||
|
elif [ -f yarn.lock ]; then \
|
||||||
|
corepack enable yarn && yarn build; \
|
||||||
|
elif [ -f pnpm-lock.yaml ]; then \
|
||||||
|
corepack enable pnpm && pnpm build; \
|
||||||
|
else \
|
||||||
|
echo "No lockfile found." && exit 1; \
|
||||||
|
fi
|
||||||
|
|
||||||
|
# ============================================
|
||||||
|
# Stage 3: Run Next.js application
|
||||||
|
# ============================================
|
||||||
|
|
||||||
|
FROM node:${NODE_VERSION} AS runner
|
||||||
|
|
||||||
|
# Set working directory
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# Set production environment variables
|
||||||
|
ENV NODE_ENV=production
|
||||||
|
ENV PORT=3000
|
||||||
|
ENV HOSTNAME="0.0.0.0"
|
||||||
|
|
||||||
|
# Next.js collects completely anonymous telemetry data about general usage.
|
||||||
|
# Learn more here: https://nextjs.org/telemetry
|
||||||
|
# Uncomment the following line in case you want to disable telemetry during the run time.
|
||||||
|
# ENV NEXT_TELEMETRY_DISABLED=1
|
||||||
|
|
||||||
|
RUN mkdir /data
|
||||||
|
|
||||||
|
# Copy production assets
|
||||||
|
COPY --from=builder --chown=node:node /app/public ./public
|
||||||
|
|
||||||
|
# Set the correct permission for prerender cache
|
||||||
|
RUN mkdir .next
|
||||||
|
RUN chown node:node .next
|
||||||
|
|
||||||
|
# Automatically leverage output traces to reduce image size
|
||||||
|
# https://nextjs.org/docs/advanced-features/output-file-tracing
|
||||||
|
COPY --from=builder --chown=node:node /app/.next/standalone ./
|
||||||
|
COPY --from=builder --chown=node:node /app/.next/static ./.next/static
|
||||||
|
|
||||||
|
# If you want to persist the fetch cache generated during the build so that
|
||||||
|
# cached responses are available immediately on startup, uncomment this line:
|
||||||
|
# COPY --from=builder --chown=node:node /app/.next/cache ./.next/cache
|
||||||
|
|
||||||
|
# Switch to non-root user for security best practices
|
||||||
|
USER node
|
||||||
|
|
||||||
|
# Expose port 3000 to allow HTTP traffic
|
||||||
|
EXPOSE 3000
|
||||||
|
|
||||||
|
# Start Next.js standalone server
|
||||||
|
CMD ["node", "server.js"]
|
||||||
@@ -1,21 +1,60 @@
|
|||||||
# Next.js template
|
# oTunes
|
||||||
|
|
||||||
This is a Next.js template with shadcn/ui.
|
Your music, my music, _**our**_ music. Self-hosted music streaming app and server.
|
||||||
|
|
||||||
## Adding components
|
## Hosting with Docker
|
||||||
|
|
||||||
To add components to your app, run the following command:
|
Here's an example `docker-compose.yml` file to get you started:
|
||||||
|
|
||||||
```bash
|
```yaml
|
||||||
npx shadcn@latest add button
|
name: music
|
||||||
|
services:
|
||||||
|
otunes:
|
||||||
|
ports:
|
||||||
|
- "3000:3000"
|
||||||
|
volumes:
|
||||||
|
- /SomeAttachedStorage/Music:/data
|
||||||
|
environment:
|
||||||
|
- NEXT_PUBLIC_CONVEX_URL=http://127.0.0.1:3210
|
||||||
|
- CONVEX_SELF_HOSTED_URL=http://127.0.0.1:3210
|
||||||
|
- CONVEX_SELF_HOSTED_ADMIN_KEY=REPLACE_ME
|
||||||
|
restart: unless-stopped
|
||||||
|
image: git.abunchofknowitalls.com/joshuafhiggins/otunes:latest
|
||||||
|
backend:
|
||||||
|
stop_grace_period: 10s
|
||||||
|
stop_signal: SIGINT
|
||||||
|
restart: unless-stopped
|
||||||
|
ports:
|
||||||
|
- "3210:3210"
|
||||||
|
- "3211:3211"
|
||||||
|
volumes:
|
||||||
|
- ./database:/convex/data
|
||||||
|
environment:
|
||||||
|
- CONVEX_CLOUD_ORIGIN=http://127.0.0.1:3210
|
||||||
|
- CONVEX_SITE_ORIGIN=http://127.0.0.1:3211
|
||||||
|
- APPLICATION_MAX_CONCURRENT_MUTATIONS=16
|
||||||
|
- APPLICATION_MAX_CONCURRENT_NODE_ACTIONS=16
|
||||||
|
- APPLICATION_MAX_CONCURRENT_QUERIES=16
|
||||||
|
- APPLICATION_MAX_CONCURRENT_V8_ACTIONS=16
|
||||||
|
- DISABLE_BEACON=true
|
||||||
|
- DISABLE_METRICS_ENDPOINT=true
|
||||||
|
- DOCUMENT_RETENTION_DELAY=172800
|
||||||
|
- DO_NOT_REQUIRE_SSL=true
|
||||||
|
- REDACT_LOGS_TO_CLIENT=true
|
||||||
|
- RUST_LOG=info
|
||||||
|
image: ghcr.io/get-convex/convex-backend:latest
|
||||||
|
healthcheck:
|
||||||
|
test: curl -f http://localhost:3210/version
|
||||||
|
interval: 5s
|
||||||
|
start_period: 10s
|
||||||
```
|
```
|
||||||
|
|
||||||
This will place the ui components in the `components` directory.
|
First run `docker compose up -d backend` and `docker compose exec backend ./generate_admin_key.sh` to generate the admin key needed for the frontend. Take this key and put it in the `CONVEX_SELF_HOSTED_ADMIN_KEY` environment variable for the `otunes` service.
|
||||||
|
|
||||||
## Using components
|
`CONVEX_SELF_HOSTED_URL`, `CONVEX_CLOUD_ORIGIN`, and `NEXT_PUBLIC_CONVEX_URL` should be changed to the same reversed proxied, SSL protected, domain and `CONVEX_SITE_ORIGIN` on a different domain.
|
||||||
|
|
||||||
To use the components in your app, import them as follows:
|
Then change `/SomeAttachedStorage/Music` to the path where your music is stored and run `docker compose down && docker compose up -d` to start the whole app together.
|
||||||
|
|
||||||
```tsx
|
## Downloads
|
||||||
import { Button } from "@/components/ui/button";
|
|
||||||
```
|
Check the releases tab for the latest downloads for apps: [Releases](https://git.abunchofknowitalls.com/joshuafhiggins/otunes/releases)
|
||||||
Reference in new issue
Block a user