mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-05 00:29:48 +03:00
Setup mail and ldap #1121
Closed
opened 2026-02-04 23:51:17 +03:00 by OVERLORD
·
12 comments
No Branch/Tag Specified
development
l10n_development
further_theme_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
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#1121
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 @TheDealman on GitHub (Apr 3, 2019).
Hello
I just installed bookstack on ubuntu 16.04 and I used the installation script to do the install for me. I would like to setup the email and LDAP auth but all the documentation references some .env file that needs to be edited. Where is this .env file that I need to edit?
@cnfw commented on GitHub (Apr 3, 2019):
Hi, there is an example .env file called
.env.examplein the root directory of the project. You can copy this to a file called.envand update the values as you need. Sometimes it may be hidden,ls -lawill show hidden files :)There's also a file called
.env.example.completewith a full list of configurable options, including LDAP options. Head the caution at the top of this file, only use the pieces of configuration you need from it.@ssddanbrown commented on GitHub (Apr 4, 2019):
Thanks @cw1998 for providing some helpful info.
@TheDealman If you're having trouble finding your BookStack install, You'll probably find it at
/var/www/bookstacksince you installed using the script.@TheDealman commented on GitHub (Apr 4, 2019):
Thanks I found it
@TheDealman commented on GitHub (Apr 4, 2019):
I will try to get this all working today
@TheDealman commented on GitHub (Apr 4, 2019):
Okay i was able to get this working in the .env file that's located /var/www/bookstack
#General auth
AUTH_METHOD=ldap
LDAP authentication configuration
LDAP_SERVER=ip of the AD server:389
LDAP_BASE_DN=OU=name,DC=ADNETBIOS,DC=SUFFIX
LDAP_DN=CN=ACCOUNT,OU=NAME OF OU,ADNETBIOS,DC=SUFFIX
LDAP_PASS=PASSWORD ACCOUNT LISTED ABOVE
LDAP_USER_FILTER=(|(mail=${user})(sAMAccountName=${user}))
LDAP_VERSION=3
LDAP_TLS_INSECURE=false
LDAP_EMAIL_ATTRIBUTE=mail
LDAP_DISPLAY_NAME_ATTRIBUTE=cn
LDAP_FOLLOW_REFERRALS=true
I was able to login using LDAP credentials but i didn't have any user roles so I changed the AUTH_METHOD to standard instead of ldap so i could login with the local admin account. I am able to see the accounts that have logged in via the ldap auth and assign roles but my question is when the ldap auth method is set how do you assign roles?
@TheDealman commented on GitHub (Apr 8, 2019):
Anyone know the answer to the above question?
@ssddanbrown commented on GitHub (Apr 8, 2019):
@TheDealman You can either set LDAP groups manually in the system and/or enable LDAP group syncing which will run when an LDAP user logs-in.
@TheDealman commented on GitHub (Apr 9, 2019):
Yes I setup a LDAP group but my question is I am able to see the accounts that have logged in via the ldap auth but how do you assign roles?
@ssddanbrown commented on GitHub (Apr 9, 2019):
@TheDealman You'd need to assign BookStack roles manually by viewing each user and selecting the roles to assign them. Otherwise you can align the names with LDAP groups to auto-set BookStack roles on login.
@TheDealman commented on GitHub (Apr 9, 2019):
How do I align the names with LDAP groups to auto-set BookStack roles on login?
@ssddanbrown commented on GitHub (May 18, 2019):
Sorry for my late response @TheDealman.
The process/logic is described in the LDAP group syncing documentation page. Ultimately, you can either configure BookStack role names to align with LDAP group names otherwise use the
External Authentication IDsBookStack role option to perform this matching.@ssddanbrown commented on GitHub (Aug 27, 2019):
Since the last comment on this issue is relatively old I'm going to close this. If the issue remains and is something you still require to be fixed please open a new issue, referencing this one.