419 Page Expired When Trying to Save Labels for Pages #4874

New Issue

Closed

opened 2026-02-05 09:22:47 +03:00 by OVERLORD · 19 comments

OVERLORD commented 2026-02-05 09:22:47 +03:00

Owner

Copy Link

Originally created by @mschoon85 on GitHub (Jul 15, 2024).

Describe the Bug

Hi @ssddanbrown

We are experiencing intermittent issues when saving a page after adding labels. The problem occurs frequently but not consistently. If it were a settings issue, it would either always work or never work. This might be worth investigating, as it can be quite annoying for our users.

Kind regards,

Michel

Steps to Reproduce

1. Create a new page
2. Add multiple labels
3. Save the page
4. Repeat until the error occurs

Expected Behaviour

No error

Screenshots or Additional Context

Browser Details

MS Edge

Exact BookStack Version

24.05.1

Originally created by @mschoon85 on GitHub (Jul 15, 2024). ### Describe the Bug Hi @ssddanbrown We are experiencing intermittent issues when saving a page after adding labels. The problem occurs frequently but not consistently. If it were a settings issue, it would either always work or never work. This might be worth investigating, as it can be quite annoying for our users. Kind regards, Michel ### Steps to Reproduce 1. Create a new page 2. Add multiple labels 3. Save the page 4. Repeat until the error occurs ### Expected Behaviour No error ### Screenshots or Additional Context  ### Browser Details MS Edge ### Exact BookStack Version 24.05.1

OVERLORD added the 🐛 Bug label 2026-02-05 09:22:47 +03:00

OVERLORD closed this issue 2026-02-05 09:22:50 +03:00

OVERLORD commented 2026-02-05 09:22:53 +03:00

Author

Owner

Copy Link

@ssddanbrown commented on GitHub (Jul 15, 2024):

Hi @mschoon85,
This will typically be something specific to your environment/scenario, and can often be due to another requested being made, and failing, in the background for some reason.

Are you familiar with the browser development tools? If so, it would be useful if you could open the console tab, then refresh then page (when in the editor), then report back the messages shown (if any).

@ssddanbrown commented on GitHub (Jul 15, 2024): Hi @mschoon85, This will typically be something specific to your environment/scenario, and can often be due to another requested being made, and failing, in the background for some reason. Are you familiar with the browser development tools? If so, it would be useful if you could open the console tab, then refresh then page (when in the editor), then report back the messages shown (if any).

OVERLORD commented 2026-02-05 09:22:56 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 15, 2024):

Hi @ssddanbrown,

When I open the page and there is nothing in the console, adding the labels and then saving the page works without any issues. However, when I see this message in the console after clicking on edit, the saving of labels fails:

Before saving:

manifest.json:1 

        GET
https://URL/manifest.json
500 (Internal Server Error)
manifest.json:1  Manifest: Line: 1, column: 1, Syntax error.
[NEW] Explain Console errors by using Copilot in Edge: click
         to explain an error. 
        Learn more

After saving:

sleutelen-aan-een-auto-op-de-openbare-weg:1 

        POST
https://URL/books/kcc-team-toezicht-en-handhaving/page/sleutelen-aan-een-auto-op-de-openbare-weg
419
[NEW] Explain Console errors by using Copilot in Edge: click
         to explain an error. 
        Learn more

Click here url: https://learn.microsoft.com/nl-nl/microsoft-edge/devtools-guide-chromium/console/copilot-explain-console#the-explain-this-error-feature

@mschoon85 commented on GitHub (Jul 15, 2024): Hi @ssddanbrown, When I open the page and there is nothing in the console, adding the labels and then saving the page works without any issues. However, when I see this message in the console after clicking on edit, the saving of labels fails: **Before saving:** ``` manifest.json:1 GET https://URL/manifest.json 500 (Internal Server Error) manifest.json:1 Manifest: Line: 1, column: 1, Syntax error. [NEW] Explain Console errors by using Copilot in Edge: click to explain an error. Learn more ``` **After saving:** ``` sleutelen-aan-een-auto-op-de-openbare-weg:1 POST https://URL/books/kcc-team-toezicht-en-handhaving/page/sleutelen-aan-een-auto-op-de-openbare-weg 419 [NEW] Explain Console errors by using Copilot in Edge: click to explain an error. Learn more ``` Click here url: https://learn.microsoft.com/nl-nl/microsoft-edge/devtools-guide-chromium/console/copilot-explain-console#the-explain-this-error-feature

OVERLORD commented 2026-02-05 09:22:58 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 15, 2024):

I have more information on the second attempt. During the first attempt, we did not wait long enough for the other errors to appear. They show up as soon as I add a label on the second attempt.

@mschoon85 commented on GitHub (Jul 15, 2024): I have more information on the second attempt. During the first attempt, we did not wait long enough for the other errors to appear. They show up as soon as I add a label on the second attempt. 

OVERLORD commented 2026-02-05 09:22:59 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 15, 2024):

@mschoon85 commented on GitHub (Jul 15, 2024):  

OVERLORD commented 2026-02-05 09:23:00 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 15, 2024):

I also notice that when I get the error message and then press the back button in the browser, SSO logs in again.

@mschoon85 commented on GitHub (Jul 15, 2024): I also notice that when I get the error message and then press the back button in the browser, SSO logs in again.

OVERLORD commented 2026-02-05 09:23:02 +03:00

Author

Owner

Copy Link

@ssddanbrown commented on GitHub (Jul 15, 2024):

Thanks for the info @mschoon85.
Can you watch your BookStack error log file and report back any errors that get added when you go through the process of adding new tags to a page.

@ssddanbrown commented on GitHub (Jul 15, 2024): Thanks for the info @mschoon85. Can you watch your [BookStack error log file](https://www.bookstackapp.com/docs/admin/debugging/#error-log-file) and report back any errors that get added when you go through the process of adding new tags to a page.

OVERLORD commented 2026-02-05 09:23:03 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

@ssddanbrown, Please find attached the logfile from the period when I was attempting to reproduce the issue. There were many errors in the console, but I was also able to save the page several times without any console errors. Eventually, I was able to reproduce the 419 Page Expired error, which should be at the end of the logfile.

laravel - Copy.log

@mschoon85 commented on GitHub (Jul 16, 2024): @ssddanbrown, Please find attached the logfile from the period when I was attempting to reproduce the issue. There were many errors in the console, but I was also able to save the page several times without any console errors. Eventually, I was able to reproduce the 419 Page Expired error, which should be at the end of the logfile. [laravel - Copy.log](https://github.com/user-attachments/files/16245606/laravel.-.Copy.log)

OVERLORD commented 2026-02-05 09:23:04 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

SQLSTATE[HY000] [1045] Access denied for user 'forge'@'localhost' (using password: NO) (Connection: mysql, SQL: select * from `users` where `system_name` = public limit 1)

SQLSTATE[HY000] [1045] Access denied for user 'forge'@'localhost' (using password: NO) (Connection: mysql, SQL: select * from `users` where `system_name` = public limit 1) (View: D:\\Apache24\\htdocs\\bookstack\\resources\\views\\layouts\\base.blade.php)

These are the two errors I have found. I do not have a user named 'forge' in the database. This user is also unknown to me. Could it be something that BookStack uses? The database user for BookStack is named 'Bookstack'.

@mschoon85 commented on GitHub (Jul 16, 2024): ``` SQLSTATE[HY000] [1045] Access denied for user 'forge'@'localhost' (using password: NO) (Connection: mysql, SQL: select * from `users` where `system_name` = public limit 1) ``` ``` SQLSTATE[HY000] [1045] Access denied for user 'forge'@'localhost' (using password: NO) (Connection: mysql, SQL: select * from `users` where `system_name` = public limit 1) (View: D:\\Apache24\\htdocs\\bookstack\\resources\\views\\layouts\\base.blade.php) ``` These are the two errors I have found. I do not have a user named 'forge' in the database. This user is also unknown to me. Could it be something that BookStack uses? The database user for BookStack is named 'Bookstack'.

OVERLORD commented 2026-02-05 09:23:05 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

I found at least one reference to a 'forge' user:

D:\Apache24\htdocs\bookstack\app\Config\database.php (2 hits)
Line 65: 'database' => env('DB_DATABASE', 'forge'),
Line 66: 'username' => env('DB_USERNAME', 'forge'),

It seems that is is set correctly:

The 'forge' user you see in the error messages is a default setting in Laravel. Laravel often uses the 'forge' user as the default database user in its configuration files, especially if the environment variables are not correctly set or if the configuration cache contains outdated values.

Causes and Solutions:
Default Setting in Laravel:

When you set up a new Laravel installation, Laravel configures the database to use the 'forge' user by default. This is intended as a placeholder until you configure your own database settings.

@mschoon85 commented on GitHub (Jul 16, 2024): I found at least one reference to a 'forge' user: D:\Apache24\htdocs\bookstack\app\Config\database.php (2 hits) Line 65: 'database' => env('DB_DATABASE', 'forge'), Line 66: 'username' => env('DB_USERNAME', 'forge'), It seems that is is set correctly: > The 'forge' user you see in the error messages is a default setting in Laravel. Laravel often uses the 'forge' user as the default database user in its configuration files, especially if the environment variables are not correctly set or if the configuration cache contains outdated values. > > Causes and Solutions: > Default Setting in Laravel: > > When you set up a new Laravel installation, Laravel configures the database to use the 'forge' user by default. This is intended as a placeholder until you configure your own database settings.

OVERLORD commented 2026-02-05 09:23:06 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

I was advised to clear the caches, but I encountered the following error:

D:\Apache24\htdocs\bookstack>php artisan config:clear

   INFO  Configuration cache cleared successfully.


D:\Apache24\htdocs\bookstack>php artisan cache:clear

   INFO  Application cache cleared successfully.


D:\Apache24\htdocs\bookstack>php artisan config:cache
PHP Fatal error:  Cannot redeclare autoSortBook() (previously declared in D:\Apache24\htdocs\bookstack\themes\custom\functions.php:14) in D:\Apache24\htdocs\bookstack\themes\custom\functions.php on line 26

In functions.php line 26:

  Cannot redeclare autoSortBook() (previously declared in D:\Apache24\htdocs\bookstack\themes\custom\functions.php:14
  )



In functions.php line 26:

  Cannot redeclare autoSortBook() (previously declared in D:\Apache24\htdocs\bookstack\themes\custom\functions.php:14
  )

@mschoon85 commented on GitHub (Jul 16, 2024): I was advised to clear the caches, but I encountered the following error: ``` D:\Apache24\htdocs\bookstack>php artisan config:clear INFO Configuration cache cleared successfully. D:\Apache24\htdocs\bookstack>php artisan cache:clear INFO Application cache cleared successfully. D:\Apache24\htdocs\bookstack>php artisan config:cache PHP Fatal error: Cannot redeclare autoSortBook() (previously declared in D:\Apache24\htdocs\bookstack\themes\custom\functions.php:14) in D:\Apache24\htdocs\bookstack\themes\custom\functions.php on line 26 In functions.php line 26: Cannot redeclare autoSortBook() (previously declared in D:\Apache24\htdocs\bookstack\themes\custom\functions.php:14 ) In functions.php line 26: Cannot redeclare autoSortBook() (previously declared in D:\Apache24\htdocs\bookstack\themes\custom\functions.php:14 ) ```

OVERLORD commented 2026-02-05 09:23:07 +03:00

Author

Owner

Copy Link

@ssddanbrown commented on GitHub (Jul 16, 2024):

Ah, a windows based apache environment.
Yeah, that can be prone to thread safety issues which is likely what's occurring here since we can see the config reflecting defaults.

Config caching can be a workaround but that will conflict with custom theme functions (we don't officially advise/document config caching) unless that's specifically handled in the theme code by wrapping functions in exist checks, eg:

if (!function_exists('autoSortBook')) {
    function autoSortBook(Book $book): void {
        /// function code here
    }
}

We could maybe look to make the theme work with cache (load functions.php only once) and/or update config usage to avoid non-thread-safe functions but some further testing required there to properly check potential impacts.

Dev references

• bba7dcce49/app/Theming/ThemeService.php (L77)
• https://github.com/laravel/framework/pull/28908
• https://github.com/laravel/framework/pull/28740

@ssddanbrown commented on GitHub (Jul 16, 2024): Ah, a windows based apache environment. Yeah, that can be prone to thread safety issues which is likely what's occurring here since we can see the config reflecting defaults. Config caching can be a workaround but that will conflict with custom theme functions (we don't officially advise/document config caching) unless that's specifically handled in the theme code by wrapping functions in exist checks, eg: ```php if (!function_exists('autoSortBook')) { function autoSortBook(Book $book): void { /// function code here } } ``` We could maybe look to make the theme work with cache (load functions.php only once) and/or update config usage to avoid non-thread-safe functions but some further testing required there to properly check potential impacts. ### Dev references - https://github.com/BookStackApp/BookStack/blob/bba7dcce49394f478bd401486a2d8cba23ff79ac/app/Theming/ThemeService.php#L77 - https://github.com/laravel/framework/pull/28908 - https://github.com/laravel/framework/pull/28740

OVERLORD commented 2026-02-05 09:23:09 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

@ssddanbrown I don't believe the theme is causing the 419 error. This issue was occurring even before we implemented the autosort 'hack'. After every Bookstack update, we clear those three caches. Last Friday, we implemented the autosort 'hack' after payment. It would be great to make this compatible with clearing the 'php artisan config' command as well.

How should we proceed with investigating the 419 issue? Did you see all my previous messages with the logs, etc.?

@mschoon85 commented on GitHub (Jul 16, 2024): @ssddanbrown I don't believe the theme is causing the 419 error. This issue was occurring even before we implemented the autosort 'hack'. After every Bookstack update, we clear those three caches. Last Friday, we implemented the autosort 'hack' after payment. It would be great to make this compatible with clearing the 'php artisan config' command as well. How should we proceed with investigating the 419 issue? Did you see all my previous messages with the logs, etc.?

OVERLORD commented 2026-02-05 09:23:10 +03:00

Author

Owner

Copy Link

@ssddanbrown commented on GitHub (Jul 16, 2024):

@mschoon85 I'm not saying the theme is causing it, but that caching can help in thread-safety-prone environments like yours, which you can't run since the combined use and implementation of the theme system is not compatible.

If you wrap your theme functions like shown above, you should be able to cache the config to avoid config thread-safety issues. You'll need to remember to re-cache (or clear) this config cache upon any future updates, or when making any .env changes in the future.

@ssddanbrown commented on GitHub (Jul 16, 2024): @mschoon85 I'm not saying the theme is causing it, but that caching can help in thread-safety-prone environments like yours, which you can't run since the combined use and implementation of the theme system is not compatible. If you wrap your theme functions like shown above, you should be able to cache the config to avoid config thread-safety issues. You'll need to remember to re-cache (or clear) this config cache upon any future updates, or when making any `.env` changes in the future.

OVERLORD commented 2026-02-05 09:23:11 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

@ssddanbrown

Wrapping the function as shown below will result in an error:

 if (!function_exists('autoSortBook')) {
    function autoSortBook(Book $book): void {
		
function autoSortBook(Book $book): void {
    $chapters = $book->chapters()->orderBy('name', 'asc')->get(['id', 'priority']);
    $pages = $book->pages()->orderBy('name', 'asc')
        ->where('draft', '=', false)
        ->get(['id', 'priority']);
    $chapterCount = $chapters->count();

    foreach ($chapters as $index => $chapter) {
        $chapter->priority = $index;
        $chapter->save();
    }

    foreach ($pages as $index => $page) {
        $page->priority = $chapterCount + $index;
        $page->save();
    }
}
   }
}

@mschoon85 commented on GitHub (Jul 16, 2024): @ssddanbrown Wrapping the function as shown below will result in an error: ``` if (!function_exists('autoSortBook')) { function autoSortBook(Book $book): void { function autoSortBook(Book $book): void { $chapters = $book->chapters()->orderBy('name', 'asc')->get(['id', 'priority']); $pages = $book->pages()->orderBy('name', 'asc') ->where('draft', '=', false) ->get(['id', 'priority']); $chapterCount = $chapters->count(); foreach ($chapters as $index => $chapter) { $chapter->priority = $index; $chapter->save(); } foreach ($pages as $index => $page) { $page->priority = $chapterCount + $index; $page->save(); } } } } ```

OVERLORD commented 2026-02-05 09:23:12 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

I did it this way, and now it works:

D:\Apache24\htdocs\bookstack>php artisan config:cache

   INFO  Configuration cached successfully.

if (!function_exists('autoSortBook')) {
    function autoSortBook(Book $book): void {
        $chapters = $book->chapters()->orderBy('name', 'asc')->get(['id', 'priority']);
        $pages = $book->pages()->orderBy('name', 'asc')
            ->where('draft', '=', false)
            ->get(['id', 'priority']);
        $chapterCount = $chapters->count();

        foreach ($chapters as $index => $chapter) {
            $chapter->priority = $index;
            $chapter->save();
        }

        foreach ($pages as $index => $page) {
            $page->priority = $chapterCount + $index;
            $page->save();
        }
    }
}

@mschoon85 commented on GitHub (Jul 16, 2024): I did it this way, and now it works: ``` D:\Apache24\htdocs\bookstack>php artisan config:cache INFO Configuration cached successfully. ``` ``` if (!function_exists('autoSortBook')) { function autoSortBook(Book $book): void { $chapters = $book->chapters()->orderBy('name', 'asc')->get(['id', 'priority']); $pages = $book->pages()->orderBy('name', 'asc') ->where('draft', '=', false) ->get(['id', 'priority']); $chapterCount = $chapters->count(); foreach ($chapters as $index => $chapter) { $chapter->priority = $index; $chapter->save(); } foreach ($pages as $index => $page) { $page->priority = $chapterCount + $index; $page->save(); } } } ```

OVERLORD commented 2026-02-05 09:23:13 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 16, 2024):

Perhaps the functions.php file on https://www.bookstackapp.com/hacks/autosort-tagged-books needs the above addition as well.

@mschoon85 commented on GitHub (Jul 16, 2024): Perhaps the functions.php file on https://www.bookstackapp.com/hacks/autosort-tagged-books needs the above addition as well.

OVERLORD commented 2026-02-05 09:23:14 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 17, 2024):

@ssddanbrown , It appears that the issue has been resolved by wrapping the function and clearing those three caches. I am currently unable to reproduce the problem.

@mschoon85 commented on GitHub (Jul 17, 2024): @ssddanbrown , It appears that the issue has been resolved by wrapping the function and clearing those three caches. I am currently unable to reproduce the problem.

OVERLORD commented 2026-02-05 09:23:15 +03:00

Author

Owner

Copy Link

@mschoon85 commented on GitHub (Jul 17, 2024):

I also noticed that the php artisan config:cache command was missing from my update script. It would be beneficial to add this command to the list on the BookStack update documentation (https://www.bookstackapp.com/docs/admin/updates/).

For your reference, or for anyone else who might be interested, here is my (powershell) update script, which includes file and database backup:

Details

# Define log file at the script scope
$script:LogFile = "D:\Update\Logs\log_PROD_$(Get-Date -Format "yyyyMMdd_HHmmss").txt"

Function Check-RunAsAdministrator()
{
  # Get current user context
  $CurrentUser = New-Object Security.Principal.WindowsPrincipal $([Security.Principal.WindowsIdentity]::GetCurrent())
  
  # Check if user is running the script as a member of Administrator Group
  if($CurrentUser.IsInRole([Security.Principal.WindowsBuiltinRole]::Administrator))
  {
       Add-Content -Path $script:LogFile -Value "Script is running with Administrator privileges!"
  }
  else
    {
       # Create a new Elevated process to Start PowerShell
       $ElevatedProcess = New-Object System.Diagnostics.ProcessStartInfo "PowerShell";
 
       # Specify the current script path and name as a parameter
       $ElevatedProcess.Arguments = "& '" + $script:MyInvocation.MyCommand.Path + "'"
 
       # Set the Process to elevated
       $ElevatedProcess.Verb = "runas"
 
       # Start the new elevated process
       [System.Diagnostics.Process]::Start($ElevatedProcess)
 
       Add-Content -Path $script:LogFile -Value "Script is being run with elevated privileges."
       
       # Exit from the current, unelevated, process
       Exit
    }
}

# Check if Script is running with Elevated Privileges
Check-RunAsAdministrator

# Define the date and time format
$datetime = Get-Date -Format "yyyyMMdd_HHmmss"
Add-Content -Path $script:LogFile -Value "Defined date and time format: $datetime"


# Define the source, temporary and destination paths
$source = "D:\Apache24\htdocs\bookstack"
$tempDestination = "D:\Backups\temp\bookstack_backup"
$datetime = Get-Date -Format "yyyyMMddHHmmss"
$destination = "D:\Backups\bookstack_backup_PROD_$datetime.zip"
Add-Content -Path $script:LogFile -Value "Defined source: $source, temporary: $tempDestination and destination: $destination paths."


# Message on screen that Robocopy is starting
Write-Host "The backup process is starting..."
    
# Copy files using Robocopy
try {
    # Run Robocopy and store the output in the variable $output
    $output = Robocopy $source $tempDestination /E /COPYALL /R:3 /W:10 2>&1

    # Display the Robocopy output on the screen
    $output | Write-Host

    # Add the Robocopy output to the log file
    Add-Content -Path $script:LogFile -Value $output

    # Add a confirmation message to the log file
    Add-Content -Path $script:LogFile -Value "Copied files from $source to $tempDestination"
} catch {
    Add-Content -Path $script:LogFile -Value "Error copying files: $_"
    exit
}

Clear-Host

# Create a zip archive from the temporary location
try {
    Compress-Archive -Path $tempDestination -DestinationPath $destination 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Created a zip archive from $tempDestination to $destination"
} catch {
    Add-Content -Path $script:LogFile -Value "Error creating zip archive: $_"
    exit
}

# Clean up the temporary directory
Remove-Item -Path $tempDestination -Recurse -Force
Add-Content -Path $script:LogFile -Value "Cleaned up the temporary files at $tempDestination"


# Load encrypted credentials from a file
try {
    $credential = Import-Clixml -Path "D:\Update\SecureCredentials.xml" 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Loaded encrypted credentials from a file."
} catch {
    Add-Content -Path $script:LogFile -Value "Error loading encrypted credentials: $_"
}

# Get the username and password from the credential object
$user = $credential.UserName
$pass = $credential.GetNetworkCredential().Password
Add-Content -Path $script:LogFile -Value "Extracted the username and password from the credential object."

# Run mysqldump with the username and password
try {
    & 'C:\Program Files\MariaDB 10.9\bin\mysqldump.exe' --user=$user --password=$pass --databases bookstack > "D:\Backups\database_backup_PROD_$datetime.sql" 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Ran mysqldump with the provided username and password."
} catch {
    Add-Content -Path $script:LogFile -Value "Error running mysqldump: $_"
}

# Change to D drive
try {
    Set-Location -Path D:\ 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Changed location to D drive."
} catch {
    Add-Content -Path $script:LogFile -Value "Error changing location to D drive: $_"
}

# Change to specific directory
try {
    Set-Location -Path .\Apache24\htdocs\bookstack 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Changed location to .\Apache24\htdocs\bookstack."
} catch {
    Add-Content -Path $script:LogFile -Value "Error changing location to .\Apache24\htdocs\bookstack: $_"
}

# Prompt the user to check if the backup was successful
$checkBackup = Read-Host -Prompt "Is the backup of the folder and the database successfully made? Please check in D:\Backups. (yes/no)"

if ($checkBackup -eq "yes") {
    # Pull from git
    try {
        git pull origin release 2>&1 | Tee-Object -Variable output
        Add-Content -Path $script:LogFile -Value "Pulled updates from git."
    } catch {
        Add-Content -Path $script:LogFile -Value "Error pulling updates from git: $_"
    }
} else {
    Add-Content -Path $script:LogFile -Value "Update cancelled by the user due to backup concerns."
    Write-Host "Update cancelled. Please check the backup and run the script again."
}

# Install composer dependencies
try {
    composer install --no-dev 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Installed composer dependencies."
} catch {
    Add-Content -Path $script:LogFile -Value "Error installing composer dependencies: $_"
}

# Run artisan migrations with --force
try {
    php artisan migrate --force 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Ran artisan migrations with --force."
} catch {
    Add-Content -Path $script:LogFile -Value "Error running artisan migrations: $_"
}

# Clear application cache
try {
    php artisan cache:clear 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Cleared application cache."
} catch {
    Add-Content -Path $script:LogFile -Value "Error clearing application cache: $_"
}

# Clear configuration cache
try {
    php artisan config:clear 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Cleared configuration cache."
} catch {
    Add-Content -Path $script:LogFile -Value "Error clearing configuration cache: $_"
}

# Clear compiled view files
try {
    php artisan view:clear 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Cleared compiled view files."
} catch {
    Add-Content -Path $script:LogFile -Value "Error clearing compiled view files: $_"
}

# Cache the configuration
try {
    php artisan config:cache 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Cached configuration."
} catch {
    Add-Content -Path $script:LogFile -Value "Error caching configuration: $_"
}

# Clean up images with force option and auto-confirm
try {
    echo "yes" | php artisan bookstack:cleanup-images --force 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Cleaned up images with force and auto-confirmation."
} catch {
    Add-Content -Path $script:LogFile -Value "Error cleaning up images with force: $_"
}

# Regenerate search index
try {
    php artisan bookstack:regenerate-search 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Regenerated search index."
} catch {
    Add-Content -Path $script:LogFile -Value "Error regenerating search index: $_"
}

# Regenerate references
try {
    php artisan bookstack:regenerate-references 2>&1 | Tee-Object -Variable output
    Add-Content -Path $script:LogFile -Value "Regenerated references."
} catch {
    Add-Content -Path $script:LogFile -Value "Error regenerating references: $_"
}

@mschoon85 commented on GitHub (Jul 17, 2024): I also noticed that the php artisan config:cache command was missing from my update script. It would be beneficial to add this command to the list on the BookStack update documentation (https://www.bookstackapp.com/docs/admin/updates/). For your reference, or for anyone else who might be interested, here is my (powershell) update script, which includes file and database backup: <details><summary>Details</summary> <p> ```powershell # Define log file at the script scope $script:LogFile = "D:\Update\Logs\log_PROD_$(Get-Date -Format "yyyyMMdd_HHmmss").txt" Function Check-RunAsAdministrator() { # Get current user context $CurrentUser = New-Object Security.Principal.WindowsPrincipal $([Security.Principal.WindowsIdentity]::GetCurrent()) # Check if user is running the script as a member of Administrator Group if($CurrentUser.IsInRole([Security.Principal.WindowsBuiltinRole]::Administrator)) { Add-Content -Path $script:LogFile -Value "Script is running with Administrator privileges!" } else { # Create a new Elevated process to Start PowerShell $ElevatedProcess = New-Object System.Diagnostics.ProcessStartInfo "PowerShell"; # Specify the current script path and name as a parameter $ElevatedProcess.Arguments = "& '" + $script:MyInvocation.MyCommand.Path + "'" # Set the Process to elevated $ElevatedProcess.Verb = "runas" # Start the new elevated process [System.Diagnostics.Process]::Start($ElevatedProcess) Add-Content -Path $script:LogFile -Value "Script is being run with elevated privileges." # Exit from the current, unelevated, process Exit } } # Check if Script is running with Elevated Privileges Check-RunAsAdministrator # Define the date and time format $datetime = Get-Date -Format "yyyyMMdd_HHmmss" Add-Content -Path $script:LogFile -Value "Defined date and time format: $datetime" # Define the source, temporary and destination paths $source = "D:\Apache24\htdocs\bookstack" $tempDestination = "D:\Backups\temp\bookstack_backup" $datetime = Get-Date -Format "yyyyMMddHHmmss" $destination = "D:\Backups\bookstack_backup_PROD_$datetime.zip" Add-Content -Path $script:LogFile -Value "Defined source: $source, temporary: $tempDestination and destination: $destination paths." # Message on screen that Robocopy is starting Write-Host "The backup process is starting..." # Copy files using Robocopy try { # Run Robocopy and store the output in the variable $output $output = Robocopy $source $tempDestination /E /COPYALL /R:3 /W:10 2>&1 # Display the Robocopy output on the screen $output | Write-Host # Add the Robocopy output to the log file Add-Content -Path $script:LogFile -Value $output # Add a confirmation message to the log file Add-Content -Path $script:LogFile -Value "Copied files from $source to $tempDestination" } catch { Add-Content -Path $script:LogFile -Value "Error copying files: $_" exit } Clear-Host # Create a zip archive from the temporary location try { Compress-Archive -Path $tempDestination -DestinationPath $destination 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Created a zip archive from $tempDestination to $destination" } catch { Add-Content -Path $script:LogFile -Value "Error creating zip archive: $_" exit } # Clean up the temporary directory Remove-Item -Path $tempDestination -Recurse -Force Add-Content -Path $script:LogFile -Value "Cleaned up the temporary files at $tempDestination" # Load encrypted credentials from a file try { $credential = Import-Clixml -Path "D:\Update\SecureCredentials.xml" 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Loaded encrypted credentials from a file." } catch { Add-Content -Path $script:LogFile -Value "Error loading encrypted credentials: $_" } # Get the username and password from the credential object $user = $credential.UserName $pass = $credential.GetNetworkCredential().Password Add-Content -Path $script:LogFile -Value "Extracted the username and password from the credential object." # Run mysqldump with the username and password try { & 'C:\Program Files\MariaDB 10.9\bin\mysqldump.exe' --user=$user --password=$pass --databases bookstack > "D:\Backups\database_backup_PROD_$datetime.sql" 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Ran mysqldump with the provided username and password." } catch { Add-Content -Path $script:LogFile -Value "Error running mysqldump: $_" } # Change to D drive try { Set-Location -Path D:\ 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Changed location to D drive." } catch { Add-Content -Path $script:LogFile -Value "Error changing location to D drive: $_" } # Change to specific directory try { Set-Location -Path .\Apache24\htdocs\bookstack 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Changed location to .\Apache24\htdocs\bookstack." } catch { Add-Content -Path $script:LogFile -Value "Error changing location to .\Apache24\htdocs\bookstack: $_" } # Prompt the user to check if the backup was successful $checkBackup = Read-Host -Prompt "Is the backup of the folder and the database successfully made? Please check in D:\Backups. (yes/no)" if ($checkBackup -eq "yes") { # Pull from git try { git pull origin release 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Pulled updates from git." } catch { Add-Content -Path $script:LogFile -Value "Error pulling updates from git: $_" } } else { Add-Content -Path $script:LogFile -Value "Update cancelled by the user due to backup concerns." Write-Host "Update cancelled. Please check the backup and run the script again." } # Install composer dependencies try { composer install --no-dev 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Installed composer dependencies." } catch { Add-Content -Path $script:LogFile -Value "Error installing composer dependencies: $_" } # Run artisan migrations with --force try { php artisan migrate --force 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Ran artisan migrations with --force." } catch { Add-Content -Path $script:LogFile -Value "Error running artisan migrations: $_" } # Clear application cache try { php artisan cache:clear 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Cleared application cache." } catch { Add-Content -Path $script:LogFile -Value "Error clearing application cache: $_" } # Clear configuration cache try { php artisan config:clear 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Cleared configuration cache." } catch { Add-Content -Path $script:LogFile -Value "Error clearing configuration cache: $_" } # Clear compiled view files try { php artisan view:clear 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Cleared compiled view files." } catch { Add-Content -Path $script:LogFile -Value "Error clearing compiled view files: $_" } # Cache the configuration try { php artisan config:cache 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Cached configuration." } catch { Add-Content -Path $script:LogFile -Value "Error caching configuration: $_" } # Clean up images with force option and auto-confirm try { echo "yes" | php artisan bookstack:cleanup-images --force 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Cleaned up images with force and auto-confirmation." } catch { Add-Content -Path $script:LogFile -Value "Error cleaning up images with force: $_" } # Regenerate search index try { php artisan bookstack:regenerate-search 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Regenerated search index." } catch { Add-Content -Path $script:LogFile -Value "Error regenerating search index: $_" } # Regenerate references try { php artisan bookstack:regenerate-references 2>&1 | Tee-Object -Variable output Add-Content -Path $script:LogFile -Value "Regenerated references." } catch { Add-Content -Path $script:LogFile -Value "Error regenerating references: $_" } ``` </p> </details>

OVERLORD commented 2026-02-05 09:23:17 +03:00

Author

Owner

Copy Link

@ssddanbrown commented on GitHub (Jul 17, 2024):

@mschoon85 I don't advise config caching in our guidance to avoid the impacts in support it can introduce. All this is rarely an issue in realistic production environments, it's only really relevant in edge cases (like Apache on windows, which I'd consider more of a dev environment to be honest).

I've opened up #5126 to look into removing the thread unsafe functions, to avoid this at a more fundamental layer.
And I've opened #5125 for improving how the theme system works with commands like config:cache (even if undocumented).
I'll therefore close this off.

@ssddanbrown commented on GitHub (Jul 17, 2024): @mschoon85 I don't advise config caching in our guidance to avoid the impacts in support it can introduce. All this is rarely an issue in realistic production environments, it's only really relevant in edge cases (like Apache on windows, which I'd consider more of a dev environment to be honest). I've opened up #5126 to look into removing the thread unsafe functions, to avoid this at a more fundamental layer. And I've opened #5125 for improving how the theme system works with commands like config:cache (even if undocumented). I'll therefore close this off.

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

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 🐛 Bug

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

OVERLORD

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/BookStack#4874