Skip to content

Commit b5f5879

Browse files
committed
improve doc
1 parent 5b9d040 commit b5f5879

File tree

2 files changed

+34
-19
lines changed

2 files changed

+34
-19
lines changed

docs/documentation/app/builder/environment-variables/_page.mdx

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@ import Warning from '../../../components/Warning'
55

66
Wasmo Builder is fully configurable and the only way to configure it is to use the environment variables.
77

8-
- [Storage](#storage)
9-
- [Authentications](#authentications)
10-
- [Pairing with Otoroshi](#pairing-with-otoroshi)
11-
- [Using the CLI](#using-the-cli)
12-
- [Miscellaneous](#miscellaneous)
138

149
## Storage <Badges values={['S3', 'DOCKER_S3', 'S3_POSTGRES', 'DOCKER_S3_POSTGRES']} raw />
1510

@@ -105,11 +100,13 @@ STORAGE=
105100
AWS_ACCESS_KEY_ID=
106101
# Specifies an secret key associated with your S3 instance
107102
AWS_SECRET_ACCESS_KEY=
108-
# The Default region name identifies the S3 Region whose servers you want to send your requests to by default
103+
# The Default region name identifies the S3 Region whose servers
104+
# you want to send your requests to by default
109105
AWS_DEFAULT_REGION= <DEFAULT 'us-east-1'>
110106
# Specifies the endpoint that is used for all service requests
111107
S3_ENDPOINT=
112-
# When set to true, the bucket name is always left in the request URI and never moved to the host as a sub-domain.
108+
# When set to true, the bucket name is always left in the request
109+
# URI and never moved to the host as a sub-domain.
113110
S3_FORCE_PATH_STYLE=
114111
# Bucket used
115112
S3_BUCKET=
@@ -123,26 +120,31 @@ GITHUB_MAX_REPO_SIZE=
123120
PG_HOST=<DEFAULT 'localhost'>
124121
PG_PORT=<DEFAULT 5432>
125122
PG_DATABASE=<DEFAULT 'wasmo'>
126-
# This optional environment variable is used in conjunction with POSTGRES_PASSWORD to set a user and its password. This variable will create the specified user with superuser power and a database with the same name
123+
# This optional environment variable is used in conjunction with
124+
# POSTGRES_PASSWORD to set a user and its password. This variable will create the specified user with superuser power and a database with the same name
127125
PG_USER=<DEFAULT 'postgres'>
128-
# It must not be empty or undefined. This environment variable sets the superuser password for PostgreSQL
126+
# It must not be empty or undefined. This environment variable
127+
# sets the superuser password for PostgreSQL
129128
PG_PASSWORD=<DEFAULT 'password'>
130129
PG_POOL_SIZE=<DEFAULT 20>
131-
# Number of milliseconds a client must sit idle in the pool and not be checked out before it is disconnected from the backend and discarded
130+
# Number of milliseconds a client must sit idle in the pool and not
131+
# be checked out before it is disconnected from the backend and discarded
132132
PG_IDLE_TIMEOUT_MILLIS=<DEFAULT 30000>
133-
# Number of milliseconds to wait before timing out when connecting a new client by default this is 0 which means no timeout
133+
# Number of milliseconds to wait before timing out when connecting
134+
# a new client by default this is 0 which means no timeout
134135
PG_CONNECTION_TIMEOUT_MILLIS=<DEFAULT 2000>
135136
136-
# Manager
137-
138-
# The location of the plugin templates. This can be a URL or a file path starting with file://
137+
# The location of the plugin templates. This can be a URL or a file
138+
# path starting with file://
139139
MANAGER_TEMPLATES=
140140
MANAGER_MAX_PARALLEL_JOBS= <DEFAULT 2>
141-
# The domains allowed to call the Wasmo backend. This list is used by the CORS policy.
141+
# The domains allowed to call the Wasmo backend.
142+
# This list is used by the CORS policy.
142143
MANAGER_ALLOWED_DOMAINS= <DEFAULT 'localhost:5001'>
143144
# Defines whether Wasmo will be secured
144145
AUTH_MODE= <'NO_AUTH'|'BASIC_AUTH'|'OTOROSHI_AUTH'>
145-
# Secret used to verify the signature of the incoming token (only used with AUTH_MODE='OTOROSHI_AUTH')
146+
# Secret used to verify the signature of the incoming token
147+
# (only used with AUTH_MODE='OTOROSHI_AUTH')
146148
OTOROSHI_TOKEN_SECRET= <DEFAULT 'veryverysecret'>
147149
148150
# Expected client id (only used with AUTH_MODE='BASIC_AUTH')
@@ -153,10 +155,23 @@ WASMO_CLIENT_SECRET=
153155
# Enables the Extism environment and the playground zone in UI
154156
EXTISM_RUNTIME_ENVIRONMENT= <DEFAULT false>
155157
156-
# At each time interval, Wasmo will clear a folder full of locally generated Wasm binaries
158+
# At each time interval, Wasmo will clear a folder full of locally generated
159+
# Wasm binaries
157160
LOCAL_WASM_JOB_CLEANING= <DEFAULT 60 * 60 * 1000> // 1 hour
158161
159162
LOGGER_FILE= <DEFAULT false>
160163
LOGGER_LEVEL= <DEFAULT 'info'>
161-
LOGGER_TIMESTAMP <DEFAULT false>
164+
LOGGER_TIMESTAMP= <DEFAULT false>
165+
166+
# Enable WebSocket protocol over https
167+
WSS= <DEFAULT false>
168+
169+
# Expose Wasmo on specific a domain and port (used to generate invitations links)
170+
# Links will be generated following the format : {SECURE_DOMAIN ? 'https' : 'http'}://${ENV.DOMAIN}:${ENV.EXPOSED_PORT || ENV.PORT}
171+
SECURE_DOMAIN= <DEFAULT false>
172+
DOMAIN=
173+
EXPOSED_PORT=
174+
175+
# Force Wasmo to validate domains of requests
176+
CHECK_DOMAINS= <DEFAULT true> # if false, MANAGER_ALLOWED_DOMAINS will be ignored
162177
```

docs/documentation/public/searchbar.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ document.querySelectorAll('a[href^="#"]').forEach(anchor => {
1717

1818
const hash = this.getAttribute('href');
1919

20-
document.querySelector(hash).scrollIntoView({
20+
document.querySelector(hash)?.scrollIntoView({
2121
behavior: 'smooth'
2222
});
2323

0 commit comments

Comments
 (0)