bookstack/website
Fork 4
Code Issues 5 Pull requests Activity

Add a section about the recycle bin settings

Browse source 
Add a section in the documentation, fixes #3667
This commit is contained in:
Alex 2022-08-25 13:13:38 +09:00 • committed by GitHub
commit 0e5660f6ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

32
content/docs/admin/other-config.md
View file

@ -8,6 +8,7 @@ type = "admin-doc"
* [.env Options](#env-options)
* [Revision Limit](#revision-limit)
* [Recycle Bin Lifetime](#recycle-bin-lifetime )
* [Custom User Avatar Fetching](#custom-user-avatar-fetching)
* [Custom diagrams.net URL](#custom-diagramsnet-url)
* [IP Address Storage Precision](#ip-address-storage-precision)
@ -40,14 +41,37 @@ REVISION_LIMIT=false
---
### Recycle Bin Lifetime
Instead of deleting pages completely, it is possible to move them to a recycle bin.
The lifespan of pages in the recycle bin can be controlled by passing an option in the `.env` file.
Three modes are available :
- `RECYCLE_BIN_LIFETIME=0` : disable the recycle bin :
- `RECYCLE_BIN_LIFETIME=-1` : do not auto-remove pages from the recycle bin
- `RECYCLE_BIN_LIFETIME=n` : try to remove pages after `n` days<sup>*</sup>
<sup>*</sup> the pages' auto-removal might be delayed.
```bash
# Recycle Bin Lifetime
# The number of days that content will remain in the recycle bin before
# being considered for auto-removal. It is not a guarantee that content will
# be removed after this time.
# Set to 0 for no recycle bin functionality.
# Set to -1 for unlimited recycle bin lifetime.
RECYCLE_BIN_LIFETIME=30
```
---
### Custom User Avatar Fetching
When a user is created BookStack will, by default, fetch an avatar image from [Gravatar](https://en.gravatar.com/). This functionality can be disabled or the URL can be customized
When a user is created BookStack will, by default, fetch an avatar image from [Gravatar](https://en.gravatar.com/). This functionality can be disabled in the `.env` file or the URL can be customized
which allows you to use a different avatar service altogether. Examples of this can be seen below:
```bash
# In your .env file
# Use libravatar instead of gravatar
AVATAR_URL=https://seccdn.libravatar.org/avatar/${hash}?s=${size}&d=identicon
@ -99,4 +123,4 @@ By default, the entire IP address will be stored but you can adjust with the fol
# For the IPv6 address '2001:db8:85a3:8d3:1319:8a2e:370:7348' this would result as:
# '2001:db8:85a3:8d3:x:x:x:x'
IP_ADDRESS_PRECISION=2
```
```