Skip to content

Missing steps/information in "Docker compose installation" guide #2293

@phlummox

Description

@phlummox

Your environment

  • Operating system: Linux (Ubuntu 22.04)
  • Commit hash: autolab/docker commit bed42d577ff8c15475f7359de051893c73daa747, autolab commit 9cc857f
  • Ruby version: N/A, uses container
  • Rails version: N/A, uses container

Steps To Reproduce

Current behavior

In several places, the documentation on installing and running Autolab using docker compose appears to have missing or unclear information.

  • Promoting a user.

    The initial "welcome" page includes (here) the following text:

    I just set up Autolab. How can I make myself an admin?

    We have a Rake task that you can run where your app is deployed to promote any user to the admin level. Just run rake 'admin:promote_user[[email protected]]' to give a user administrative privileges. Note that the user has to exist already.

    It's unclear whether this needs to be done if installing the system using docker-compose - could the installation guide clarify this?

    Assuming it does need to be done, it's not immediately clear where the rake command has to be run. From what I can gather, one needs to run

      docker exec -it autolab bash
    

    to get shell access in the autolab container, then

      RAILS_ENV=production rake 'admin:promote_user[[email protected]]' 
    

    to apply the promotion. Mentioning this in the documentation would be helpful.

  • Missing step - build required docker images

    [edit: removed this - actually it is discussed; I somehow missed it.]

  • Missing information - development vs production environment.

    It's not clear what kind of environment (development or production) the docker compose files are set up to reproduce, nor how to switch from one to the other. It would be helpful if the installation guide clarified this. There are a few lines in the docker-compose.yml file that seem to be relevant (e.g. line 43), but it would be good if the installation guide could clarify this.

Expected behavior

The installation guide should have reasonably complete information on how to install and run Autolab, including alternative environments and navigating the first few screens.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions