mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-08 03:09:39 +03:00
APP_PROXIES works for Audit Log but does not work for NGinx error.log #2938
Closed
opened 2026-02-05 05:48:15 +03:00 by OVERLORD
·
6 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
🐛 Bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/BookStack#2938
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 @jducaud on GitHub (Aug 4, 2022).
Describe the Bug
Setting the
APP_PROXIESto*allows theAudit LogofBookStackto display the real IP address of the user.In the security-topic documentation we can see:
This option is
LOG_FAILED_LOGIN_MESSAGE(set, as advised, to"Failed login for %u").So one could logically think - as
Fail2Banis only effective if it has access to the IP address of the attacker - thatAPP_PROXIESandLOG_FAILED_LOGIN_MESSAGEare the perfect combo to track repeated failed login attempts.That is not the case. The
APP_PROXIESoption works forAudit Log(as advertized in the BookStack 21.10 release notes), and theLOG_FAILED_LOGIN_MESSAGEoption yields a message in theNGinx error.logas expected:But they do not yield an
NGinxerror message which can be used byFail2Ban, as172.23.0.1is aDocker bridgeinterface IP address, not the user real address.Steps to Reproduce
docker-compose.ymlfile, setAPP_PROXIESto*docker-compose.ymlfile, setLOG_FAILED_LOGIN_MESSAGEto"Failed login for %u"BookStackandMariaDB)BookStackNGinx error.logfileExpected Behaviour
Setting both
APP_PROXIESandLOG_FAILED_LOGIN_MESSAGEshould yield a message with the real IP address of the user in theNGinx error.logfile.We could also imagine that beside the
%uvariable in the failed login message, there could also be a%ivariable for the IP address.Screenshots or Additional Context
No response
Browser Details
Firefox 103.0 (64-bit) - Windows 11 Home (10.0.22000)
Exact BookStack Version
22.07.1 (LinuxServer.io 22.07.1-ls29)
PHP Version
7.4.26
Hosting Environment
@ssddanbrown commented on GitHub (Aug 4, 2022):
Hi @jducaud,
I don't want to complicate the
LOG_FAILED_LOGIN_MESSAGEsystem if possible, since it's really a rarely used feature.I think the fundamental request can be achieved on the nginx side like described here:
https://serverfault.com/questions/896130/possible-to-log-x-forwarded-for-to-nginx-error-log
@jducaud commented on GitHub (Aug 4, 2022):
Hi @ssddanbrown,
Thank you for this link. Luckily, the
Nginxversion of theLinuxServer.io BookStackcontainer has been built with thengx_http_realip_module! So I added to the server context ofNginxthe following lines:And it worked. The
Nginxerror.log now displays the real user IP address. Thank you very much for your advice.If I may, I would say that the
BookStackdocumentation I quoted should be fixed. Indeed, in any case, theLOG_FAILED_LOGIN_MESSAGEoption is not useful forFail2Ban. Thanks to theAPP_PROXIESoption, it could have been useful forFail2Banbut it is actually not. My feeling about thisLOG_FAILED_LOGIN_MESSAGEoption is that it has no real-life use and has missed its original intended purpose. Too bad.Anyway, you brilliantly saved me. Thank you again!
@ssddanbrown commented on GitHub (Aug 4, 2022):
Good to know things are working
I don't really understand. What makes you say this? How does it miss the intended purpose?
@jducaud commented on GitHub (Aug 4, 2022):
When I say "the
LOG_FAILED_LOGIN_MESSAGEoption (...) has no real-life use and has missed its original intended purpose", I refer to the BookStack documentation (security topic):The original intent - if I read correctly - was to allow the use of tools such as
Fail2Ban. Well, theLOG_FAILED_LOGIN_MESSAGEoption is useless for tools such as Fail2Ban, as it does not provide a way to get the real IP address of the user/attacker in the logs.That makes me think this option has only made half of the trip. It yields a message (calling the
php error_logfunction) in theNginx error.logfile but only provides a%uvariable, useless to effectively ban an IP address. The other half of the trip has to be done by the elegant workaround you gave me (Nginx real-IPmodule).@ssddanbrown commented on GitHub (Aug 4, 2022):
The
LOG_FAILED_LOGIN_MESSAGEoption does not log an IP address itself, since it almost always logs to locations that themselves will contain the IP address. The nginx addition here was only needed because you're in a proxy-based setup. This is not a required step in a non-proxy setup.Stating
My feeling about this LOG_FAILED_LOGIN_MESSAGE option is that it has no real-life use and has missed its original intended purpose. Too badmisses the fact that option has indeed provided a way to use Fail2Ban to track failed login attempts, something which would be more difficult without this feature.@jducaud commented on GitHub (Aug 4, 2022):
I do agree with you that there is no problem when using
BookStackupfront (not in a container and not behind a reverse proxy). But am I the only person who wants to useBookStackin aDockercontainer, behind a reverse proxy? Is this setup so uncommon and twisted that it is completely out of topic regarding theBookStackdocumentation? I do not think so. Two containerized versions ofBookStackare proposed as links (LinuxServ.ioandsolidnerd) and there is even an option (APP_PROXIES) which deals with proxy-based setups (at least for theAudit Logfeature).Nonetheless I admit that saying this option has "no real-life use" was wrong (as it has - as you pointed - at least one use case).