An idiot-proof guide to setting up retrospring?

[Sylphystia]

Hi! I would like to try setting up my own personal retrospring instance, but I am struggling even after attempting the set-up from scratch a few times. So I thought perhaps using the package provided might be easier, but I have never used docker before, so I am at a loss of what I'm supposed to do literally just after the docker pull command... I attempted docker run, but it doesn't seem to result in anything.

[pixeldesu]

While we use the image in production...our setup is rather special, and we don't really have a lot of experience with just regular Docker in Production setups either, that's why there is no setup description for that yet.

What are the troubles you faced with the source installation method? Which step did you get stuck at, etc. I can try to give you some pointers (and maybe even improve the documentation in the process).

Not exactly sure if we can make it fully "idiot-proof" because any way will require some technical knowledge.

[Sylphystia]

With the source installation method, I have gotten all the way to the last setting up step, but cannot figure out how to solve this error:

E: Figured I had to edit the Procfile to start on production and not development, but it's still not working. IT appears to just stop itself immediately?

retrospring@retrospring:~/retrospring$ foreman start
13:37:00 web.1    | started with pid 27958
13:37:00 worker.1 | started with pid 27959
13:37:00 css.1    | started with pid 27960
13:37:00 js.1     | started with pid 27961
13:37:02 css.1    | yarn run v1.22.22
13:37:02 js.1     | yarn run v1.22.22
13:37:03 css.1    | $ sass ./app/assets/stylesheets/application.sass.scss:./app/assets/builds/application.css --no-source-map --load-path=node_modules --watch
13:37:03 js.1     | $ esbuild app/javascript/*.* --bundle --sourcemap --outdir=app/assets/builds --public-path=assets --watch
13:37:04 js.1     | [watch] build finished, watching for changes...
13:37:16 web.1    | processing time of bundler require: 10.016s
13:37:16 web.1    | => Booting Puma
13:37:16 web.1    | => Rails 7.0.8.4 application starting in production 
13:37:16 web.1    | => Run `bin/rails server --help` for more startup options
13:37:18 worker.1 | processing time of bundler require: 8.565s
13:37:20 worker.1 | 2024-10-02T13:37:20.628Z pid=27959 tid=mhr INFO: Booting Sidekiq 6.5.12 with Sidekiq::RedisConnection::RedisAdapter options {:url=>"redis://localhost:6379"}
13:37:21 web.1    | DEPRECATION WARNING: Support for Rails versions < 7.1 is deprecated and will be removed from ViewComponent 4.0.0 (ViewComponent v4 will remove support for Rails versions < 7.1 no earlier than April 1, 2025) (called from <main> at /home/retrospring/retrospring/config/environment.rb:6)
13:37:21 worker.1 | DEPRECATION WARNING: Support for Rails versions < 7.1 is deprecated and will be removed from ViewComponent 4.0.0 (ViewComponent v4 will remove support for Rails versions < 7.1 no earlier than April 1, 2025) (called from <top (required)> at /home/retrospring/retrospring/config/environment.rb:6)
13:37:21 worker.1 | 2024-10-02T13:37:21.482Z pid=27959 tid=mhr WARN: NameError: uninitialized constant Bullet
13:37:21 worker.1 | 2024-10-02T13:37:21.482Z pid=27959 tid=mhr WARN: /home/retrospring/retrospring/config/environments/development.rb:3:in `block (2 levels) in <main>'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.8.4/lib/active_support/lazy_load_hooks.rb:92:in `block in execute_hook'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.8.4/lib/active_support/lazy_load_hooks.rb:85:in `with_execution_control'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.8.4/lib/active_support/lazy_load_hooks.rb:90:in `execute_hook'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.8.4/lib/active_support/lazy_load_hooks.rb:76:in `block in run_load_hooks'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.8.4/lib/active_support/lazy_load_hooks.rb:75:in `each'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/activesupport-7.0.8.4/lib/active_support/lazy_load_hooks.rb:75:in `run_load_hooks'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/railties-7.0.8.4/lib/rails/application/finisher.rb:87:in `block in <module:Finisher>'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/railties-7.0.8.4/lib/rails/initializable.rb:32:in `instance_exec'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/railties-7.0.8.4/lib/rails/initializable.rb:32:in `run'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/railties-7.0.8.4/lib/rails/initializable.rb:61:in `block in run_initializers'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:228:in `block in tsort_each'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:350:in `block (2 levels) in each_strongly_connected_component'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:431:in `each_strongly_connected_component_from'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:349:in `block in each_strongly_connected_component'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:347:in `each'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:347:in `call'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:347:in `each_strongly_connected_component'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:226:in `tsort_each'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/tsort.rb:205:in `tsort_each'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/railties-7.0.8.4/lib/rails/initializable.rb:60:in `run_initializers'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/railties-7.0.8.4/lib/rails/application.rb:372:in `initialize!'
13:37:21 worker.1 | /home/retrospring/retrospring/config/environment.rb:6:in `<top (required)>'
13:37:21 worker.1 | <internal:/home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
13:37:21 worker.1 | <internal:/home/retrospring/.rbenv/versions/3.2.3/lib/ruby/3.2.0/rubygems/core_ext/kernel_require.rb>:38:in `require'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/sidekiq-6.5.12/lib/sidekiq/cli.rb:286:in `boot_application'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/sidekiq-6.5.12/lib/sidekiq/cli.rb:53:in `run'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/gems/sidekiq-6.5.12/bin/sidekiq:31:in `<top (required)>'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/bin/sidekiq:25:in `load'
13:37:21 worker.1 | /home/retrospring/retrospring/vendor/bundle/ruby/3.2.0/bin/sidekiq:25:in `<top (required)>'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/cli/exec.rb:58:in `load'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/cli/exec.rb:58:in `kernel_load'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/cli/exec.rb:23:in `run'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/cli.rb:451:in `exec'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/vendor/thor/lib/thor/command.rb:28:in `run'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/vendor/thor/lib/thor/invocation.rb:127:in `invoke_command'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/vendor/thor/lib/thor.rb:527:in `dispatch'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/cli.rb:34:in `dispatch'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/vendor/thor/lib/thor/base.rb:584:in `start'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/cli.rb:28:in `start'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/exe/bundle:28:in `block in <top (required)>'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/lib/bundler/friendly_errors.rb:117:in `with_friendly_errors'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.5/exe/bundle:20:in `<top (required)>'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/bin/bundle:25:in `load'
13:37:21 worker.1 | /home/retrospring/.rbenv/versions/3.2.3/bin/bundle:25:in `<main>'
13:37:22 web.1    | processing time of routes.rb: 0.909s
13:37:22 web.1    | processing time of routes.rb: 0.565s
13:37:22 web.1    | processing time of Rails.application.initialize!: 6.130s
13:37:22 web.1    | Puma starting in single mode...
13:37:22 web.1    | * Puma version: 6.4.3 (ruby 3.2.3-p157) ("The Eagle of Durango")
13:37:22 web.1    | *  Min threads: 5
13:37:22 web.1    | *  Max threads: 5
13:37:22 web.1    | *  Environment: production
13:37:22 web.1    | *          PID: 27962
13:37:22 web.1    | * Listening on http://0.0.0.0:3000
13:37:22 web.1    | Use Ctrl-C to stop
13:37:22 worker.1 | exited with code 1
13:37:22 system   | sending SIGTERM to all processes
13:37:22 web.1    | terminated by SIGTERM
13:37:22 css.1    | exited with code 1
13:37:22 js.1     | exited with code 1

[Sylphystia]

Inexplicably, after re-trying a fresh install about ten times, it finally worked and the site is online. I will mark this as closed for now!

[az5he6ch]

I've been able to run it in Docker from the published images but it took a bit of digging and experimentation. It's a bit of a bodge still. The static files for Nginx are manually copied over and there were a few manual steps documented in the source install that had to be run also. Config files need to be copied into the volume and edited as required. Secrets and config are spread all over the place which is not ideal. Hopefully it can provide a place to start from though.

docker-compose.yml

services:
  web:
    image: ghcr.io/retrospring/retrospring:main
    command: bundle exec puma -C config/puma.rb -b tcp://0.0.0.0:3000
    depends_on:
      - postgres
      - redis
    volumes:
      - config:/opt/retrospring/app/config
      - cache:/cache
    environment:
      SECRET_KEY_BASE: hunter3
      CACHE_REDIS_URL: redis://redis:6379
      SPROCKETS_CACHE: /cache
      RAILS_LOG_TO_STDOUT: true
    restart: unless-stopped

  sidekiq:
    image: ghcr.io/retrospring/retrospring:main
    command: bundle exec sidekiq
    depends_on:
      - postgres
      - redis
    volumes:
      - config:/opt/retrospring/app/config
    environment:
      SECRET_KEY_BASE: hunter3
      REDIS_URL: redis://redis:6379
      RAILS_LOG_TO_STDOUT: true
      SMTP_PORT: 25
      SMTP_CA_FILE: /etc/ssl/ca-bundle.pem
      SMTP_SERVER: smtp.sendgrid.net
      SMTP_DELIVERY_METHOD: smtp
      SMTP_LOGIN: apikey
      SMTP_PASSWORD: hunter2
    restart: unless-stopped

  postgres:
    image: postgres:10
    environment:
      POSTGRES_PASSWORD: hunter42069
      POSTGRES_DB: justask_production
    volumes:
      - db:/var/lib/postgresql/data

  redis:
    image: redis:6-alpine
    volumes:
      - redis:/data
    restart: unless-stopped

  nginx:
    image: nginx:alpine
    volumes:
      - static:/data
      - ./nginx.conf:/etc/nginx/conf.d/justask.conf
    ports:
      - 3000:3000
    restart: unless-stopped

volumes:
  config:
  db:
  cache:
  redis:
  static:

nginx.conf

server {
    listen 3000;

    root /data;
    access_log /var/log/nginx/justask.log;

    client_max_body_size 5M;

    error_page 404 = /404.html;
    error_page 422 = /422.html;
    error_page 500 = /500.html;
    error_page 502 = /502.html;

    try_files $uri @justask;

    location @justask {
        proxy_set_header  X-Real-IP  $remote_addr;
        proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_max_temp_file_size 0;

        proxy_pass http://web:3000;
        break;
    }
}