Skip to content

Installation instructions outdated #512

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kekcsi opened this issue Oct 7, 2024 · 2 comments
Closed

Installation instructions outdated #512

kekcsi opened this issue Oct 7, 2024 · 2 comments

Comments

@kekcsi
Copy link

kekcsi commented Oct 7, 2024

Hello, I was trying to build and install a bookstack using your image. I faced a number of issues.
First, the version uploaded to docker hub is rather old, with bookstack v22.04. I could install but I needed the newer features, so I came to build one myself.
Second, the "docker run" commands in the README.md don't work with the newer version of bookstack. They lack the -e APP_KEY=whatever\ line. Even if I add that, the app can't start properly, instead of login, I get an "unexpected error" page.
Furthermore, you cannot mount the .env file because the startup scripts would want to rename it and fail. So the modified docker run command also doesn't work as suggested in the README.md file.
As opposed to the compose yaml, where there is mysql 8.3, we still get the old 5.7.21 version of mysql in README.md "docker run" commands.
With docker compose, the server will start up and show a login page, but the default [email protected] user name is not accepted because the new bookstack version demands a real e-mail address.
Anyway thanks for your hard work, I hope this helps to improve the documentation. Workaround is to compose and then enter:
docker exec -u root -it docker-bookstack-master_bookstack_1 bash
root@60*******a61:/var/www/bookstack# php artisan bookstack:create-admin
But I didn't yet find the correct way to do the installation steps mentioned.

@ssddanbrown
Copy link
Contributor

First, the version uploaded to docker hub is rather old, with bookstack v22.04. I could install but I needed the newer features, so I came to build one myself.

New versions are uploaded to docker hub as can be seen here, and latest points the the current release, and the commands in the readme & compose refer to the latest version.
It's just that docker hub shows an old version by default for some reason.

but the default [email protected] user name is not accepted because the new bookstack version demands a real e-mail address.

This should not be the case, at least that's not something that's changed in BookStack.

@rjhenry
Copy link
Collaborator

rjhenry commented Mar 25, 2025

First, the version uploaded to docker hub is rather old, with bookstack v22.04. I could install but I needed the newer features, so I came to build one myself.

As @ssddanbrown mentioned, new versions are still built and pushed to the Docker Hub page. Unfortunately, I don't have access to the Docker Hub page to update the README there, as I only have access to this repository. Secrets were configured with @solidnerd to allow workflows to push updated images.

Second, the "docker run" commands in the README.md don't work with the newer version of bookstack. They lack the -e APP_KEY=whatever\ line. Even if I add that, the app can't start properly, instead of login, I get an "unexpected error" page.

Thanks, I've updated that as part of #533. Sorry it took so long to get back to you! Note that the README does (and did) specify that this variable was required since commit c5219c8 in July of 2023.

Furthermore, you cannot mount the .env file because the startup scripts would want to rename it and fail. So the modified docker run command also doesn't work as suggested in the README.md file.

The use of an in-container .env file has been removed since 23.6.2, as noted in the Changes section of the README. Thanks for pointing out the incorrect statement further down, which I've changed in #534.

As opposed to the compose yaml, where there is mysql 8.3, we still get the old 5.7.21 version of mysql in README.md "docker run" commands.

Thanks, where Renovate updates the Compose file for me this had escaped my notice. I'll try and keep on top of it better in the future, but for now I've updated the documentation in #532.

With docker compose, the server will start up and show a login page, but the default [email protected] user name is not accepted because the new bookstack version demands a real e-mail address.

As @ssddanbrown mentioned, this isn't a change in Bookstack and it's not something we're doing, either. I've just confirmed this running both with a Compose stack and with the Docker run commands, and both accepted the default credentials.

I'm going to close this one off, as all of the issues you've raised have been fixed - thanks for raising the problems, and again I'm sorry it took so long to get back to you!

@rjhenry rjhenry closed this as completed Mar 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants