prepare for dokku deploy
parent
98b28bcd4f
commit
387db3e708
72
Dockerfile
72
Dockerfile
|
|
@ -1,72 +0,0 @@
|
|||
# syntax=docker/dockerfile:1
|
||||
# check=error=true
|
||||
|
||||
# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand:
|
||||
# docker build -t plays_hub .
|
||||
# docker run -d -p 80:80 -e RAILS_MASTER_KEY=<value from config/master.key> --name plays_hub plays_hub
|
||||
|
||||
# For a containerized dev environment, see Dev Containers: https://guides.rubyonrails.org/getting_started_with_devcontainer.html
|
||||
|
||||
# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
|
||||
ARG RUBY_VERSION=3.4.4
|
||||
FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
|
||||
|
||||
# Rails app lives here
|
||||
WORKDIR /rails
|
||||
|
||||
# Install base packages
|
||||
RUN apt-get update -qq && \
|
||||
apt-get install --no-install-recommends -y curl libjemalloc2 libvips postgresql-client && \
|
||||
rm -rf /var/lib/apt/lists /var/cache/apt/archives
|
||||
|
||||
# Set production environment
|
||||
ENV RAILS_ENV="production" \
|
||||
BUNDLE_DEPLOYMENT="1" \
|
||||
BUNDLE_PATH="/usr/local/bundle" \
|
||||
BUNDLE_WITHOUT="development"
|
||||
|
||||
# Throw-away build stage to reduce size of final image
|
||||
FROM base AS build
|
||||
|
||||
# Install packages needed to build gems
|
||||
RUN apt-get update -qq && \
|
||||
apt-get install --no-install-recommends -y build-essential git libpq-dev libyaml-dev pkg-config && \
|
||||
rm -rf /var/lib/apt/lists /var/cache/apt/archives
|
||||
|
||||
# Install application gems
|
||||
COPY Gemfile Gemfile.lock ./
|
||||
RUN bundle install && \
|
||||
rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
|
||||
bundle exec bootsnap precompile --gemfile
|
||||
|
||||
# Copy application code
|
||||
COPY . .
|
||||
|
||||
# Precompile bootsnap code for faster boot times
|
||||
RUN bundle exec bootsnap precompile app/ lib/
|
||||
|
||||
# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
|
||||
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile
|
||||
|
||||
|
||||
|
||||
|
||||
# Final stage for app image
|
||||
FROM base
|
||||
|
||||
# Copy built artifacts: gems, application
|
||||
COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
|
||||
COPY --from=build /rails /rails
|
||||
|
||||
# Run and own only the runtime files as a non-root user for security
|
||||
RUN groupadd --system --gid 1000 rails && \
|
||||
useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
|
||||
chown -R rails:rails db log storage tmp
|
||||
USER 1000:1000
|
||||
|
||||
# Entrypoint prepares the database.
|
||||
ENTRYPOINT ["/rails/bin/docker-entrypoint"]
|
||||
|
||||
# Start server via Thruster by default, this can be overwritten at runtime
|
||||
EXPOSE 80
|
||||
CMD ["./bin/thrust", "./bin/rails", "server"]
|
||||
84
README.md
84
README.md
|
|
@ -1,24 +1,82 @@
|
|||
# README
|
||||
# Plays Hub
|
||||
|
||||
This README would normally document whatever steps are necessary to get the
|
||||
application up and running.
|
||||
A Rails application for tracking and visualizing your Spotify listening statistics.
|
||||
|
||||
Things you may want to cover:
|
||||
## Setup Instructions
|
||||
|
||||
* Ruby version
|
||||
### 1. Prerequisites
|
||||
- Ruby (see `.ruby-version` or Gemfile for version)
|
||||
- PostgreSQL
|
||||
- Node.js & Yarn (for JS/CSS assets)
|
||||
- Redis (if using caching or background jobs)
|
||||
|
||||
* System dependencies
|
||||
### 2. Clone the Repository
|
||||
```sh
|
||||
git clone <your-repo-url>
|
||||
cd plays-hub
|
||||
```
|
||||
|
||||
* Configuration
|
||||
### 3. Install Dependencies
|
||||
```sh
|
||||
bundle install
|
||||
yarn install --check-files
|
||||
```
|
||||
|
||||
* Database creation
|
||||
### 4. Environment Variables
|
||||
Create a `.env` file (or set these in your environment):
|
||||
|
||||
* Database initialization
|
||||
| Variable | Description |
|
||||
|----------------------------------|------------------------------------------|
|
||||
| `SPOTIFY_CLIENT_ID` | Your Spotify App Client ID |
|
||||
| `SPOTIFY_CLIENT_SECRET` | Your Spotify App Client Secret |
|
||||
| `SPOTIFY_REDIRECT_URI` | Your app's public base URL (no trailing slash), e.g. `https://yourdomain.com` |
|
||||
| `PLAYS_HUB_DATABASE_PASSWORD` | Password for the main production database |
|
||||
| `PLAYS_HUB_QUEUE_DATABASE_PASSWORD` | Password for the Solid Queue DB (production) |
|
||||
| `RAILS_ENV` | (optional) Rails environment, e.g. `development` |
|
||||
| `PORT` | (optional) Port to run the Rails server |
|
||||
|
||||
* How to run the test suite
|
||||
### 5. Database Setup
|
||||
```sh
|
||||
rails db:create db:migrate
|
||||
rails db:queue_migrate
|
||||
```
|
||||
|
||||
* Services (job queues, cache servers, search engines, etc.)
|
||||
### 6. Running the App
|
||||
```sh
|
||||
rails server
|
||||
```
|
||||
|
||||
* Deployment instructions
|
||||
### 7. Background Jobs
|
||||
- This app uses [Solid Queue](https://github.com/basecamp/solid_queue) for background jobs.
|
||||
- Jobs are scheduled via `config/recurring.yml` (e.g., to fetch Spotify activities regularly).
|
||||
- To run background jobs:
|
||||
```sh
|
||||
bin/rails solid_queue:start
|
||||
```
|
||||
|
||||
* ...
|
||||
### 8. Spotify Integration
|
||||
- On first login, users must connect their Spotify account.
|
||||
- Make sure your Spotify app's redirect URI matches `SPOTIFY_REDIRECT_URI` + `/spotify_callback`.
|
||||
|
||||
### 9. Running Tests
|
||||
```sh
|
||||
bundle exec rspec
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Environment Variables Summary
|
||||
- `SPOTIFY_CLIENT_ID`
|
||||
- `SPOTIFY_CLIENT_SECRET`
|
||||
- `SPOTIFY_REDIRECT_URI`
|
||||
- `PLAYS_HUB_DATABASE_PASSWORD`
|
||||
- `PLAYS_HUB_QUEUE_DATABASE_PASSWORD`
|
||||
|
||||
Set these in your `.env` or via your deployment provider's secrets manager.
|
||||
|
||||
---
|
||||
|
||||
## Additional Notes
|
||||
- See `config/recurring.yml` for scheduled jobs.
|
||||
- See `Gemfile` for required gems.
|
||||
- For any issues, check logs and ensure all ENVs are set correctly.
|
||||
|
|
|
|||
Loading…
Reference in New Issue