mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-06 09:09:38 +03:00
How to Change domain on Bookstack #3524
Closed
opened 2026-02-05 06:59:39 +03:00 by OVERLORD
·
27 comments
No Branch/Tag Specified
development
further_theme_development
l10n_development
release
llm_only
vectors
v25-11
docker_env
drawio_rendering
user_permissions
ldap_host_failover
svg_image
prosemirror
captcha_example
fix/video-export
v25.12.3
v25.12.2
v25.12.1
v25.12
v25.11.6
v25.11.5
v25.11.4
v24.11.4
v25.11.3
v25.11.2
v25.11.1
v25.11
v25.07.3
v25.07.2
v25.07.1
v25.07
v25.05.2
v25.05.1
v25.05
v25.02.5
v25.02.4
v25.02.3
v25.02.2
v25.02.1
v25.02
v24.12.1
v24.12
v24.10.3
v24.10.2
v24.10.1
v24.10
v24.05.4
v24.05.3
v24.05.2
v24.05.1
v24.05
v24.02.3
v24.02.2
v24.02.1
v24.02
v23.12.3
v23.12.2
v23.12.1
v23.12
v23.10.4
v23.10.3
v23.10.2
v23.10.1
v23.10
v23.08.3
v23.08.2
v23.08.1
v23.08
v23.06.2
v23.06.1
v23.06
v23.05.2
v23.05.1
v23.05
v23.02.3
v23.02.2
v23.02.1
v23.02
v23.01.1
v23.01
v22.11.1
v22.11
v22.10.2
v22.10.1
v22.10
v22.09.1
v22.09
v22.07.3
v22.07.2
v22.07.1
v22.07
v22.06.2
v22.06.1
v22.06
v22.04.2
v22.04.1
v22.04
v22.03.1
v22.03
v22.02.3
v22.02.2
v22.02.1
v22.02
v21.12.5
v21.12.4
v21.12.3
v21.12.2
v21.12.1
v21.12
v21.11.3
v21.11.2
v21.11.1
v21.11
v21.10.3
v21.10.2
v21.10.1
v21.10
v21.08.6
v21.08.5
v21.08.4
v21.08.3
v21.08.2
v21.08.1
v21.08
v21.05.4
v21.05.3
v21.05.2
v21.05.1
v21.05
v21.04.6
v21.04.5
v21.04.4
v21.04.3
v21.04.2
v21.04.1
v21.04
v0.31.8
v0.31.7
v0.31.6
v0.31.5
v0.31.4
v0.31.3
v0.31.2
v0.31.1
v0.31.0
v0.30.7
v0.30.6
v0.30.5
v0.30.4
v0.30.3
v0.30.2
v0.30.1
v0.30.0
v0.29.3
v0.29.2
v0.29.1
v0.29.0
v0.28.3
v0.28.2
v0.28.1
v0.28.0
v0.27.5
v0.27.4
v0.27.3
v0.27.2
v0.27.1
v0.27
v0.26.4
v0.26.3
v0.26.2
v0.26.1
v0.26.0
v0.25.5
v0.25.4
v0.25.3
v0.25.2
v0.25.1
v0.25.0
v0.24.3
v0.24.2
v0.24.1
v0.24.0
v0.23.2
v0.23.1
v0.23.0
v0.22.0
v0.21.0
v0.20.3
v0.20.2
v0.20.1
v0.20.0
v0.19.0
v0.18.5
v0.18.4
v0.18.3
v0.18.2
v0.18.1
v0.18.0
v0.17.4
v0.17.3
v0.17.2
v0.17.1
v0.17.0
v0.16.3
v0.16.2
v0.16.1
v0.16.0
v0.15.3
v0.15.2
v0.15.1
v0.15.0
v0.14.3
v0.14.2
v0.14.1
v0.14.0
v0.13.1
v0.13.0
v0.12.2
v0.12.1
v0.12.0
v0.11.2
v0.11.1
v0.11.0
v0.10.0
v0.9.3
v0.9.2
v0.9.1
v0.9.0
v0.8.2
v0.8.1
v0.8.0
v0.7.6
v0.7.5
v0.7.4
v0.7.3
0.7.2
v.0.7.1
v0.7.0
v0.6.3
v0.6.2
v0.6.1
v0.6.0
v0.5.0
Labels
Clear labels
🎨 Design
📖 Docs Update
🐛 Bug
🐛 Bug
:cat2:🐈 Possible duplicate
💿 Database
☕ Open to discussion
💻 Front-End
🐕 Support
🚪 Authentication
🌍 Translations
🔌 API Task
🏭 Back-End
⛲ Upstream
🔨 Feature Request
🛠️ Enhancement
🛠️ Enhancement
🛠️ Enhancement
❤️ Happy feedback
🔒 Security
🔍 Pending Validation
💆 UX
📝 WYSIWYG Editor
🌔 Out of scope
🔩 API Request
:octocat: Admin/Meta
🖌️ View Customization
❓ Question
🚀 Priority
🛡️ Blocked
🚚 Export System
♿ A11y
🔧 Maintenance
> Markdown Editor
pull-request
Mirrored from GitHub Pull Request
No Label
🐕 Support
Milestone
No items
No Milestone
Projects
Clear projects
No project
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/BookStack#3524
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @Nitro-Zeus98 on GitHub (Feb 22, 2023).
Attempted Debugging
Searched GitHub Issues
Describe the Scenario
Hi, i have used this ticket as "help" to my problem; https://github.com/BookStackApp/BookStack/issues/2305
But I cant get it to work, I want to change my domain name for bookstack since it's expiring soon, an I already have a new ready.
I tried to enter the path -> cd /etc/apache2/sites-enabled
then -> sudo nano bookstack.conf
ctrl + W
ctrl + R
i replaced my old domain with the new one. and saved the file.
Then exit and tried to restart apache with the command -> service apache2 restart
But i get error, see the picture.
Dont know what to do here?
I have installed Bookstack with this guide: https://www.bookstackapp.com/docs/admin/installation/
Ubuntu 22.04 Installation Script without any errors. before now where i need to change the domain name.
Exact BookStack Version
Ubuntu 22.04 Installation Script
Log Content
No response
PHP Version
No response
Hosting Environment
Server hosted in Hetzner on ESXI
The Virtual Machine with bookstack is sitting behind a pFsense firewall.
@ssddanbrown commented on GitHub (Feb 22, 2023):
@Nitro-Zeus98 Based on that error, it's very likely the edited apache config file is now invalid in some way.
The shown output is providing a hint to gain more information on the error.
Run
sudo journalctl -xeu apache2.serviceto gain more info on what's wrong. Otherwise you might find more info in the apache error log file (Commonly at/var/log/apache2/error.log).@Nitro-Zeus98 commented on GitHub (Feb 22, 2023):
i have changed the domain back as i did not work with the new one, so i can still access bookstack and everything.
See .txt and picture, what log do you want me to open ?

journalctl .txt
@ssddanbrown commented on GitHub (Feb 22, 2023):
@Nitro-Zeus98
error.logis the one. Runningtail -n 500 error.logshould give you the last 500 lines of it.@Nitro-Zeus98 commented on GitHub (Feb 23, 2023):
The website is currently on https://nitrozeus.site/
See the two pictures.


@ssddanbrown commented on GitHub (Feb 23, 2023):
@Nitro-Zeus98 Thanks but you may have gotten to that a little late. Same with the
journalctl.txtprovided above. These logs can fill fairly fast. Ideally you'll want to check these right after the error has occurred so that the error should be expected at the end of the logs.@Nitro-Zeus98 commented on GitHub (Feb 23, 2023):
alright, that makes sense, so what do you want me to do? I tried to change the domain name from nitrozeus.site to cloud-chefen.dk it did not work, so I changed it back. can you give me a guide perhaps on how to do that, I only need to change the domain, I will use certbot later to create a certificate for the domain.
@ssddanbrown commented on GitHub (Feb 23, 2023):
You could check the logs right after causing the error to occur again.
Alternatively, you could provide your config file and explain the changes you made to see if there's anything obvious.
@Nitro-Zeus98 commented on GitHub (Mar 1, 2023):
I'm not so experienced in this. all did was follow the same thing that was posted here: https://github.com/BookStackApp/BookStack/issues/2305
Is it possible for you to tell me what to do, if I need to change the domain, where should I make the changes? I cannot find any guide on it anywhere :(
If I could just get a how-to I would have no problem doing so, but I need to know where to do the changes :)
@ssddanbrown commented on GitHub (Mar 1, 2023):
@Nitro-Zeus98 I'd need to know the current state of your BookStack Apache config first to be able to accurately make recommendations. There are things, such as if HTTPS is at play in the config, that can significantly change the steps required.
@Nitro-Zeus98 commented on GitHub (Mar 1, 2023):
alright, what info would you like me to send to you :)
HTTPS does not matter, i will use certbot later to create that for the new domain.
Let me know the commands i should run and i will send you data.
@ssddanbrown commented on GitHub (Mar 1, 2023):
Please provide the contents of the
/etc/apache2/sites-available/bookstack.conffile if it exists.@Nitro-Zeus98 commented on GitHub (Mar 1, 2023):
@ssddanbrown commented on GitHub (Mar 1, 2023):
Okay, Since there's HTTPS variants for the current apache config it's properly cleaner to set things up as a new virtualhost entry. Before anything, ensure you have the machine backed-up/snapshotted if possible. Some of these commands are potentially dangerous to the system or BookStack content.
If you encounter errors along the way, or things are not as you might expect, stop at that step and report back.
Step 1
Create a new apache virtualhost file, with the path & name:
/etc/apache2/sites-available/bs2023.conf, containing the below contents. Replace the single instance ofdocs.example.comwith your new domain in the content of this file.Step 2
Activate the above config via
sudo a2ensite bs2023.conf.Then restart apache via
sudo systemctl restart apache2.service.Step 3
Assuming the domain is pointing at your server, test access by visiting your domain URL.
Visit with
/loginon the end if your site requires login. You should see your BookStack instance load on that URLbut any further links may lead you back to the old site. Also, styles could be missing making everything look strange, that's expected and we'll adjust that later.
Step 4
Go through the certbot process now if you're looking to add HTTPS. Run certbot and select the new domain.
Easiest to do that now to avoid repeating the next couple of steps.
Step 5
Now we need to configure the new domain with BookStack.
Edit the
/var/www/bookstack/.envfile and update theAPP_URLvariable to start with the new base URL for your BookStack site. This should start withhttp://(orhttps://if done step 4) and should not have a trailing slash.Step 6
Now, we need to update the URL in the BookStack database content. This can be done via the below command, but you'll need to replace the two URLs in this command, so the old base URL is first, and the new base URL is second.
@ssddanbrown commented on GitHub (Mar 6, 2023):
Since there's been no follow-up on the above I'll close this off but feel free to still comment if needed.
@Nitro-Zeus98 commented on GitHub (Mar 7, 2023):
Sorry for the late replies, have been kinda busy
The virtual machine is backed up with Veeam to a storage box.
Step one, how do i create a new apache virtual host file. How do i do that.
is there no other way than this :O I just ned the domain name changed? it's okay to remove the https if that helps?
@ssddanbrown commented on GitHub (Mar 7, 2023):
You just create and edit a file at the described name (Using your favourite editor like nano or vim or whatever).
There's probably a few ways, I have tried to provide the most direct way I could explain since the exiting website state can complicate matters.
Not really, but i've made this optional as touched upon in step 4.
@Nitro-Zeus98 commented on GitHub (Mar 7, 2023):
Alright so step one the following command goes
sudo nano /etc/apache2/sites-available/bs2023.confthe replace
docs.example.comwithcloud-chefen.dkand paste in the commandstep 2 does not work, i have not tried to type anything after that, what should i write.

@ssddanbrown commented on GitHub (Mar 7, 2023):
I'm not sure I understand, that looks like it's worked.
Run the other command i listed in step 2 then move on to step 3.
@Nitro-Zeus98 commented on GitHub (Mar 7, 2023):
my bad xD
i have some issues with firewall rules, regarding certificate registration, i will fix that and return later with info
@Nitro-Zeus98 commented on GitHub (Mar 8, 2023):
i think that's all should i do more as of now?

@ssddanbrown commented on GitHub (Mar 8, 2023):
@Nitro-Zeus98 If you've gone through all the steps, that's all that should be needed.
@Nitro-Zeus98 commented on GitHub (Mar 8, 2023):
should i do as it says on the picture
"Be sure to run
php artisan cache:clearto clear any old URLs in the cache" ?Website seems to be working amazing with the new domain name, Thank you so much <3 you don't know how much this means to me :)
@ssddanbrown commented on GitHub (Mar 8, 2023):
Might as well, there's no harm in running that.
Happy to hear that, thanks, and happy to help!
@Nitro-Zeus98 commented on GitHub (Mar 8, 2023):
Hmm does not seem to work xD

@ssddanbrown commented on GitHub (Mar 8, 2023):
@Nitro-Zeus98 Such commands are ran from your BookStack install directory.
So
cd /var/www/bookstackfirst then run the command.@Nitro-Zeus98 commented on GitHub (Mar 8, 2023):
Amazing works like a champ, thanks again Dan this is very much appreciated. Hope you have a nice day :)

@ssddanbrown commented on GitHub (Mar 8, 2023):
Awesome! will go ahead and close this off.