Skip to content

Commit b1dc827

Browse files
committed
update docs
1 parent 298bda4 commit b1dc827

4 files changed

Lines changed: 49 additions & 7 deletions

File tree

docs/introduction.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,18 +30,29 @@ The rich text editor has support for markdown shortcuts.
3030
- **Search**: Quickly find the information you need with powerful search capabilities.
3131
- **File Attachment**: Attach files to your pages for easy reference and sharing.
3232
- **Import / Export**: You can easily import and export pages in Markdown and HTML formats.
33-
- **Translations**: Docmost is available in over 10+ languages. 🇺🇸 🇨🇳 🇫🇷 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇧🇷 🇷🇺 🇪🇸🇫🇷
33+
- Zip import
34+
- Notion import
35+
- Confluence import (Enterprise Edition)
36+
- **Read/Edit preference mode:** Say goodbye to accidental edits.
37+
- **Translations**: Docmost is available in over 10+ languages. 🇺🇸 🇨🇳 🇫🇷 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇧🇷 🇷🇺 🇪🇸🇫🇷🇺🇦
3438

3539
## Authentication
3640
- Email and password
3741
- SSO (SAML/OIDC) is available in our enterprise edition [<a href="mailto:sales@docmost.com?subject=Docmost Enterprise License">Purchase enterprise license</a>].
3842

43+
## Enterprise Edition Features
44+
- SSO (SAML 2.0 / OIDC ) - Integrate Microsoft Entra ID, Okta, OneLogin and more.,
45+
- Confluence importer
46+
- Email support
47+
- Audit logs (coming soon)
48+
- [<a href="mailto:sales@docmost.com?subject=Docmost Enterprise Edition.">Purchase enterprise edition</a>].
49+
3950
## FAQ
4051
**How do I install Docmost?**
4152
We have written an installation guide for you. You can find it on the [installation page](./installation).
4253

4354
**Do you have a cloud version if I don't want to host it myself?**
44-
Yes! You can subscribe to our cloud version at [https://docmost.com/pricing](https://docmost.com/pricing?ref=docs).
55+
Yes! You can get started with our cloud version at [https://app.docmost.com](https://app.docmost.com/create?ref=docs).
4556

4657
**What license does Docmost use?**
4758
Docmost is licensed under the open-source [AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html) 3.0 License.<br />
@@ -51,4 +62,4 @@ Enterprise features are available under an enterprise license (Enterprise Editio
5162
Yes, we have an enterprise version with SSO integration. Contact <a href="mailto:sales@docmost.com">sales@docmost.com</a> to purchase an enterprise license.
5263

5364
**Got anymore questions?**
54-
Feel free to email me at _philip at docmost.com_.
65+
Feel free to email the founder: philip@docmost.com.

docs/self-hosting/configuration/index.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ MAIL_FROM_NAME=Docmost
3030

3131
## File Storage
3232
Docmost supports both local storage and S3-compatible storage drivers. The default driver is `local storage`.
33-
33+
```shell
34+
STORAGE_DRIVER=local
35+
```
3436

3537
### Using S3-Compatible Storage
3638
If you wish to use an S3-compatible storage, you have to add the below environment variables:
@@ -47,4 +49,25 @@ AWS_S3_FORCE_PATH_STYLE=
4749

4850
Being S3-compatible means Docmost can work with AWS S3, Backblaze, Wasabi, DigitalOcean Spaces, Minio, and other S3-compatible providers.
4951

52+
53+
### File upload limit
54+
The maximum file size that can be uploaded on the editor.
55+
```shell
56+
FILE_UPLOAD_LIMIT=100mb
57+
```
58+
59+
### File import size limit
60+
The maximum size limit for an import file.
61+
```shell
62+
FILE_IMPORT_SIZE_LIMIT=200mb
63+
```
64+
65+
## Telemetry
66+
We anonymously collect the active version, user count, page count, space and workspace count.
67+
To disable telemetry:
68+
```shell
69+
DISABLE_TELEMETRY=true
70+
```
71+
72+
5073
Refer to the [Environment Variables](/self-hosting/environment-variables) to see all available environment variables.

docs/self-hosting/environment-variables.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ To configure your application, set the following environment variables. These va
3434
| Variable | Example | Description |
3535
|---------------------|---------|----------------------------------------------------|
3636
| `STORAGE_DRIVER` | `local` | The storage driver to use for file storage. |
37-
| `FILE_UPLOAD_SIZE_LIMIT` | `50mb` | The maximum file size per upload. Default is 50mb. |
3837

3938
### Using S3-compatible storage
4039

@@ -48,6 +47,15 @@ To configure your application, set the following environment variables. These va
4847
| `AWS_S3_ENDPOINT` | | The endpoint URL for your S3 service (optional). |
4948
| `AWS_S3_FORCE_PATH_STYLE` | `true` | Force the request to use path-style addressing (optional). |
5049

50+
51+
### Storage file upload limits
52+
53+
| Variable | Example | Description |
54+
|--------------------------|---------|-------------------------------------------------------|
55+
| `FILE_UPLOAD_SIZE_LIMIT` | `50mb` | The maximum file size per upload. Default is 50mb. |
56+
| `FILE_IMPORT_SIZE_LIMIT` | `100mb` | The maximum file import size limit. Default is 200mb. |
57+
58+
5159
## Email Configuration
5260

5361
### Using SMTP
@@ -79,7 +87,7 @@ The default Draw.io embed url is `https://embed.diagrams.net`.
7987
| `DRAWIO_URL` | `https://embed.diagrams.net` | Your custom draw.io server url. |
8088

8189
## Telemetry
82-
We only collect the active version, user count, page count, space and workspace count.
90+
We anonymously collect the active version, user count, page count, space and workspace count.
8391

8492
| Variable | Example | Description |
8593
|-----------| ------------------------ |----------------------------|

docs/self-hosting/installation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ vi docker-compose.yml
5656
The downloaded `docker-compose.yml` file should contain the template below with default environment variables.
5757

5858
:::info
59-
`APP_URL` is optional, but useful for correct email links.
59+
`APP_URL` should be the domain you can access docmost from. e.g `https://docmost.example.com`
6060
:::
6161

6262
```yaml title="docmost/docker-compose.yml"

0 commit comments

Comments
 (0)