elabftw/elabdoc

Source files for generating documentation for elabftw

elabdoc's Issues

add synology doc

.

The switch repos in the fork may not work

Describe the bug
The documentation says:

Go on [the repository on GitHub](https://github.com/elabftw/elabftw)
    Click the Star button (it helps with visibility of the project)
    Click the Fork button in the top right of the screen
    From your fork page, clone it with SSH on your machine:

git clone [email protected]:<YOUR USERNAME>/elabftw.git
# checkout the hypernext branch because this is where dev happens
cd elabftw
git checkout hypernext
cd ..
A clear and concise description of what the bug is.

But if I fork, I fork a branch, and I do not have the hypernext in the local branch. I have to fork the hypernext branch, then I can pull it, but for me it shall be my master branch. Or there is a step I did not get...
To Reproduce
Steps to reproduce the behavior:

1. go to the elabftw/elabftw master branch, and make a fork
2. make the local dir, and do the cloning as described
3. try to switch branch with git

I think, you simply have to fork the hypernext branch, and clone that one.

Error using standard '/etc/elabftw.yml' generated by a fresh installation

Description of the bug
Configuring eLabFTW with elabctl fails with an error at 'elabctl start'

To Reproduce
Steps to reproduce the behavior:

1. Install 'docker' (verified by 'docker run hello-world')
2. Download 'elabctl' and make it executable
3. Generate '/etc/elabftw.yml' the command 'elabctl install' & answering the questions
4. Starting the script (command 'elabctl start') produces the error:

ERROR: The Compose file '/etc/elabftw.yml' is invalid because:
services.web.depends_on contains an invalid type, it should be an array

Expected behavior
Script 'elabctl start'' should run without errors.

Additional context
Content of the original script:

    # make sure we wait for mysql to be available before starting
    # comment this out if you're not using a mysql container
    # note: the mysql container needs an healthcheck block for this to work
    depends_on:
      mysql:
        condition: service_healthy

Many solutions on the web suggest to change the code to fulfill the "type: array" requirement:

    depends_on:
      - mysql:
        condition: service_healthy

But this only changes the error to:

ERROR: The Compose file '/etc/elabftw.yml' is invalid because:
services.web.depends_on contains an invalid type, it should be a string

(By the way: Only one error can be true!
The type in the config file should be the type required by the program. Here the 'required type' changes with the config file.)

Here is a modified script that at least solved the config file issue for me:

        depends_on:
      - mysql
      #  condition: service_healthy

Now elabctl complains about ERROR: Couldn't connect to Docker daemon at http+docker://localhost - is it running?. But this is another issue ...