Skip to content

Commit c4f9851

Browse files
chore: update docs
1 parent 93acb2c commit c4f9851

File tree

8 files changed

+429
-203
lines changed

8 files changed

+429
-203
lines changed

Writerside/images/capture.webp

8.44 KB
Binary file not shown.

Writerside/images/capture_dark.webp

9.04 KB
Binary file not shown.

Writerside/topics/Configuration.md

Lines changed: 39 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# Configuration
22

3+
> From v1.0.0, you can configure Memospot via the built-in interface,
4+
> accessible from `Application > Settings` menu (`CtrlOrCmd`+`,`). {style="note"}
5+
36
Though there's no need for a regular user to ever touch this file,
47
some of the Memospot behavior can be configured via `memospot.yaml`.
58

6-
## Configuration location
9+
## File location
710

811
- Linux/macOS:
912

@@ -36,7 +39,7 @@ some of the Memospot behavior can be configured via `memospot.yaml`.
3639
3740
## Sample configuration file
3841
39-
The fields that default to `null` are detected at runtime.
42+
Fields that default to `null` are detected at runtime.
4043
4144
```yaml
4245
memos:
@@ -72,14 +75,16 @@ memos:
7275
# during Memospot startup.
7376
port: 0
7477
75-
# Custom environment variables for Memos.
76-
# Custom keys will be automatically uppercased
77-
# and prefixed with "MEMOS_".
78-
# Make sure to always quote custom env values,
79-
# so they get parsed as strings.
80-
# env:
81-
# NEW_ENV_VAR: "my value"
82-
env: null
78+
env:
79+
# Custom environment variables for Memos.
80+
# https://www.usememos.com/docs/install/runtime-options
81+
#
82+
# Make sure to always quote custom env values,
83+
# so they get parsed as strings.
84+
enabled: false
85+
vars:
86+
MEMOS_DRIVER: 'postgres'
87+
MEMOS_DSN: 'postgresql://root:password@localhost:5432/memos'
8388
8489
memospot:
8590
backups:
@@ -89,6 +94,14 @@ memospot:
8994
# Backup directory.
9095
path: null
9196
97+
env:
98+
# Custom environment variables for Memospot itself.
99+
# May be used to override hardware acceleration on Linux.
100+
enabled: false
101+
vars:
102+
WEBKIT_DISABLE_DMABUF_RENDERER: '0'
103+
WEBKIT_DISABLE_COMPOSITING_MODE: '0'
104+
92105
migrations:
93106
# Enable migrations [true]. These are database
94107
# migrations that make upgrading Memos smoother.
@@ -109,24 +122,27 @@ memospot:
109122
# Other web apps most likely won't pass the internal health check.
110123
enabled: false
111124
url: https://demo.usememos.com/
125+
user_agent: 'Memospot/1.0.0'
112126
113127
updater:
114128
# Enable auto-updater [true].
115129
# - Added in v0.1.7.
130+
# Can be used to disable the updater
131+
# entirely and prevent notifications.
116132
enabled: true
117133
118134
window:
119135
# Window properties.
120136
# - Added in v0.1.7.
121-
# Managed variables store the previous state upon app close.
137+
# > Managed variables store the previous state upon app close.
122138
123139
# Whether the window should be centered upon creation. [true]
124140
center: true
125141
126142
# Whether the window should be fullscreen upon creation. [false]
127143
fullscreen: false
128144
129-
# Whether the window should be resizable upon creation. [true]
145+
# Whether the user can resize the window. [true]
130146
resizable: true
131147
132148
# (Managed) Whether the window should be maximized upon creation.
@@ -143,4 +159,15 @@ memospot:
143159
144160
# (Managed) Window initial y position.
145161
y: 0
162+
163+
# Hide the menu bar [false].
164+
# * This setting is not available from the settings screen.
165+
hide_menu_bar: false
166+
167+
# theme: [system] | light | dark
168+
theme: system
169+
170+
# locale [system] | en | [pt-BR]
171+
locale: system
172+
146173
```

0 commit comments

Comments
 (0)