overleaf / overleaf/toolkit

unclear installation depedency on <data> dirs

Open
#262 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
1.3k
Forks
310
Avg merge
3d 12h
Merged PRs (30d)
1

Description

Steps to Reproduce

  1. Follow the installation steps in a fresh environment e.g. a virtual machine

Expected Behaviour

The required local dirs should be either automatically created (add to an init script?) or mentioned as prerequisites:

Maciejs-MacBook-Pro:overleaf-toolkit maciejskorski$ ls data
git-bridge      mongo           overleaf        redis

Observed Behaviour

With no data dirs, e.g. in a fresh environment, docker compose fails to start a container.

Context

Technical Info

Analysis

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by following the installation steps in a fresh environment and inspect the Docker Compose configuration that fails when data directories are absent. Check whether the toolkit has an initialization script or documented prerequisites; done means a fresh setup creates or clearly requests the required directories and docker compose starts successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker-compose, shell
Domain
devops, infrastructure
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.