Skip to content
Snippets Groups Projects
  • Daniel Hunsaker's avatar
    256e3adc
    Add Support for Nanobox (#1709) · 256e3adc
    Daniel Hunsaker authored
    * Nanobox Support
    
    - Added support for running Mastodon using Nanobox, both for local development, and for deployment to production
    - Dev mode tested and is working properly
    - Deployment is undergoing test as of this writing. If it works, this line will be amended to state success; if not, one or more subsequent commits will provide fixes.
    
    * [nanobox] Resolve Deploy Issues
    
    Everything seems to work except routing to the streaming API. Will investigate with the Nanobox staff and make fix commits if needed.
    
    Changes made:
    - Also need `NODE_ENV` in production
    - Node runs on `:4000`
    - Use `envsubst` to commit `.env.production` values, since `dotEnv` packages don't always support referencing other variables
    - Can't precompile assets after `transform` hook, but do this locally so it only has to be done once.
    - Rails won't create `production.log` on its own, so we do this ourselves.
    - Some `start` commands run from `/data/` for some reason, so use absolute paths in command arguments
    
    * [nanobox] Update Ruby version
    
    * [nanobox] Fix db.rake Ruby code style issues
    
    * [nanobox] Minor Fixes
    
    Some minor adjustments to improve functionality:
    
    - Fixed routing to `web.stream` instances
    - Adjust `.env.nanobox` to properly generate a default `SMTP_FROM_ADDRESS` via `envsubst`
    - Update Nginx configs to properly support the needed HTTP version and headers for proper functionality (the streaming API doesn't work without some of these settings in place)
    
    * [nanobox] Move usage info to docs repo
    
    * [nanobox] Updates for 1.2.x
    
    - Need to leave out `pkg-config` since Nanobox deploys without Ruby's headers - create a gem group to exclude the gem during Nanobox installs, but allow it to remain part of the default set otherwise
    - Update cron jobs to cover new/updated Rake tasks
    - Update `.env.nanobox` to include latest defaults and additions
    
    * [nanobox] Fix for nokogumbo, added in 1.3.x
    
    Apparently, nokogumbo (pulled in by sanitize, added with `OEmbed Support for PreviewCard` (#2337) - 88725d6c) tries to install before nokogiri, despite needing nokogiri available to build properly. Instruct it to use the same settings as nokogiri does when building nokogiri directly, instead of via bundler.
    
    * [nanobox] Set NODE_ENV during asset compile
    
    The switch to WebPack will rely on the local value of the NODE_ENV evar, so set it to production during asset compilation.
    
    * [nanobox] Rebase on master; update Nginx configs
    
    - `pkg-config` Gem no longer causes issues in Nanobox, so revert the Gemfile change which allowed excluding it
    - Update Nginx configuration files with latest recommendations from production documentation
    - Rebase on master to Get This Merged™
    
    Everything should be golden!
    256e3adc
    History
    Add Support for Nanobox (#1709)
    Daniel Hunsaker authored
    * Nanobox Support
    
    - Added support for running Mastodon using Nanobox, both for local development, and for deployment to production
    - Dev mode tested and is working properly
    - Deployment is undergoing test as of this writing. If it works, this line will be amended to state success; if not, one or more subsequent commits will provide fixes.
    
    * [nanobox] Resolve Deploy Issues
    
    Everything seems to work except routing to the streaming API. Will investigate with the Nanobox staff and make fix commits if needed.
    
    Changes made:
    - Also need `NODE_ENV` in production
    - Node runs on `:4000`
    - Use `envsubst` to commit `.env.production` values, since `dotEnv` packages don't always support referencing other variables
    - Can't precompile assets after `transform` hook, but do this locally so it only has to be done once.
    - Rails won't create `production.log` on its own, so we do this ourselves.
    - Some `start` commands run from `/data/` for some reason, so use absolute paths in command arguments
    
    * [nanobox] Update Ruby version
    
    * [nanobox] Fix db.rake Ruby code style issues
    
    * [nanobox] Minor Fixes
    
    Some minor adjustments to improve functionality:
    
    - Fixed routing to `web.stream` instances
    - Adjust `.env.nanobox` to properly generate a default `SMTP_FROM_ADDRESS` via `envsubst`
    - Update Nginx configs to properly support the needed HTTP version and headers for proper functionality (the streaming API doesn't work without some of these settings in place)
    
    * [nanobox] Move usage info to docs repo
    
    * [nanobox] Updates for 1.2.x
    
    - Need to leave out `pkg-config` since Nanobox deploys without Ruby's headers - create a gem group to exclude the gem during Nanobox installs, but allow it to remain part of the default set otherwise
    - Update cron jobs to cover new/updated Rake tasks
    - Update `.env.nanobox` to include latest defaults and additions
    
    * [nanobox] Fix for nokogumbo, added in 1.3.x
    
    Apparently, nokogumbo (pulled in by sanitize, added with `OEmbed Support for PreviewCard` (#2337) - 88725d6c) tries to install before nokogiri, despite needing nokogiri available to build properly. Instruct it to use the same settings as nokogiri does when building nokogiri directly, instead of via bundler.
    
    * [nanobox] Set NODE_ENV during asset compile
    
    The switch to WebPack will rely on the local value of the NODE_ENV evar, so set it to production during asset compilation.
    
    * [nanobox] Rebase on master; update Nginx configs
    
    - `pkg-config` Gem no longer causes issues in Nanobox, so revert the Gemfile change which allowed excluding it
    - Update Nginx configuration files with latest recommendations from production documentation
    - Rebase on master to Get This Merged™
    
    Everything should be golden!
.env.nanobox 3.66 KiB
# Service dependencies
# You may set REDIS_URL instead for more advanced options
REDIS_HOST=$DATA_REDIS_HOST
REDIS_PORT=6379
# REDIS_DB=0

# You may set DATABASE_URL instead for more advanced options
DB_HOST=$DATA_DB_HOST
DB_USER=$DATA_DB_USER
DB_NAME=gonano
DB_PASS=$DATA_DB_PASS
DB_PORT=5432

# Federation
# Note: Changing LOCAL_DOMAIN or LOCAL_HTTPS at a later time will cause unwanted side effects.
# LOCAL_DOMAIN should *NOT* contain the protocol part of the domain e.g https://example.com.
LOCAL_DOMAIN=${APP_NAME}.nanoapp.io
LOCAL_HTTPS=false

# Use this only if you need to run mastodon on a different domain than the one used for federation.
# You can read more about this option on https://github.com/tootsuite/documentation/blob/master/Running-Mastodon/Serving_a_different_domain.md
# DO *NOT* USE THIS UNLESS YOU KNOW *EXACTLY* WHAT YOU ARE DOING.
# WEB_DOMAIN=mastodon.example.com

# Use this if you want to have several aliases handler@example1.com
# handler@example2.com etc. for the same user. LOCAL_DOMAIN should not
# be added. Comma separated values
# ALTERNATE_DOMAINS=example1.com,example2.com

# Application secrets
# Generate each with the `rake secret` task (`nanobox run bundle exec rake secret`)
PAPERCLIP_SECRET=$PAPERCLIP_SECRET
SECRET_KEY_BASE=$SECRET_KEY_BASE
OTP_SECRET=$OTP_SECRET

# Registrations
# Single user mode will disable registrations and redirect frontpage to the first profile
# SINGLE_USER_MODE=true
# Prevent registrations with following e-mail domains
# EMAIL_DOMAIN_BLACKLIST=example1.com|example2.de|etc
# Only allow registrations with the following e-mail domains
# EMAIL_DOMAIN_WHITELIST=example1.com|example2.de|etc

# Optionally change default language
# DEFAULT_LOCALE=de

# E-mail configuration
# Note: Mailgun and SparkPost (https://sparkpo.st/smtp) each have good free tiers
# If you want to use an SMTP server without authentication (e.g local Postfix relay)
# then set SMTP_AUTH_METHOD and SMTP_OPENSSL_VERIFY_MODE to 'none' and
# *comment* SMTP_LOGIN and SMTP_PASSWORD (leaving them blank is not enough).
SMTP_SERVER=$SMTP_SERVER
SMTP_PORT=587
SMTP_LOGIN=$SMTP_LOGIN
SMTP_PASSWORD=$SMTP_PASSWORD
SMTP_FROM_ADDRESS=notifications@${APP_NAME}.nanoapp.io
#SMTP_DOMAIN= # defaults to LOCAL_DOMAIN
#SMTP_DELIVERY_METHOD=smtp # delivery method can also be sendmail
#SMTP_AUTH_METHOD=plain
#SMTP_CA_FILE=/etc/ssl/certs/ca-certificates.crt
#SMTP_OPENSSL_VERIFY_MODE=peer
#SMTP_ENABLE_STARTTLS_AUTO=true


# Optional user upload path and URL (images, avatars). Default is :rails_root/public/system. If you set this variable, you are responsible for making your HTTP server (eg. nginx) serve these files.
# PAPERCLIP_ROOT_PATH=/var/lib/mastodon/public-system
# PAPERCLIP_ROOT_URL=/system

# Optional asset host for multi-server setups
# CDN_HOST=assets.example.com

# S3 (optional)
# S3_ENABLED=true
# S3_BUCKET=
# AWS_ACCESS_KEY_ID=
# AWS_SECRET_ACCESS_KEY=
# S3_REGION=
# S3_PROTOCOL=http
# S3_HOSTNAME=192.168.1.123:9000

# S3 (Minio Config (optional) Please check Minio instance for details)
# S3_ENABLED=true
# S3_BUCKET=
# AWS_ACCESS_KEY_ID=
# AWS_SECRET_ACCESS_KEY=
# S3_REGION=
# S3_PROTOCOL=https
# S3_HOSTNAME=
# S3_ENDPOINT=
# S3_SIGNATURE_VERSION=

# Optional alias for S3 if you want to use Cloudfront or Cloudflare in front
# S3_CLOUDFRONT_HOST=

# Streaming API integration
# STREAMING_API_BASE_URL=

# Advanced settings
# If you need to use pgBouncer, you need to disable prepared statements:
# PREPARED_STATEMENTS=false

# Cluster number setting for streaming API server.
# If you comment out following line, cluster number will be `numOfCpuCores - 1`.
STREAMING_CLUSTER_NUM=1

# Docker mastodon user
# If you use Docker, you may want to assign UID/GID manually.
# UID=1000
# GID=1000