sorb/ThreadNet-Web
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 4 Wiki Activity

Update docs

Browse Source
This commit is contained in:
Michael Telatynski
2026-06-08 10:32:55 +01:00
parent 799d33278f
commit 5d5c59473b
4 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/web/README.md
+1 -1
View File
@@ -126,5 +126,5 @@ Element Web supports a module system that allows you to extend or modify functio
Modules are extensions that can add or modify Element Web's functionality. They are: Modules are extensions that can add or modify Element Web's functionality. They are:
- Built using the [`@element-hq/element-web-module-api`](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api) - Built using the [`@element-hq/element-web-module-api`](https://github.com/element-hq/element-web/tree/develop/packages/module-api)
- Loaded in EW via [config.json](../../docs/config.md#modules) - Loaded in EW via [config.json](../../docs/config.md#modules)
docs/config.md
+1 -1
View File
@@ -596,7 +596,7 @@ Currently, the following UI feature flags are supported:
} }
``` ```
Each module URL is loaded using dynamic import (`import()`). The modules are loaded in order after Element Web initializes but before the application fully starts. Modules must be accessible from the browser and should export a compatible module format that works with the [Module API](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api). Each module URL is loaded using dynamic import (`import()`). The modules are loaded in order after Element Web initializes but before the application fully starts. Modules must be accessible from the browser and should export a compatible module format that works with the [Module API](https://github.com/element-hq/element-web/tree/develop/packages/module-api).
## Undocumented / developer options ## Undocumented / developer options
docs/deprecated-modules.md
+1 -1
View File
@@ -1,7 +1,7 @@
# Deprecated Module system # Deprecated Module system
> [!CAUTION] > [!CAUTION]
> DEPRECATED. Use [Element web module api](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api) instead. > DEPRECATED. Use [Element web module api](https://github.com/element-hq/element-web/tree/develop/packages/module-api) instead.
The module system in Element Web is a way to add or modify functionality of Element Web itself, bundled at compile time The module system in Element Web is a way to add or modify functionality of Element Web itself, bundled at compile time
for the app. This means that modules are loaded as part of the `pnpm build` process but have an effect on user experience for the app. This means that modules are loaded as part of the `pnpm build` process but have an effect on user experience
docs/install.md
+1 -1
View File
@@ -66,7 +66,7 @@ on other runtimes may require root privileges. To resolve this, either run the
image as root (`docker run --user 0`) or, better, change the port that nginx image as root (`docker run --user 0`) or, better, change the port that nginx
listens on via the `ELEMENT_WEB_PORT` environment variable. listens on via the `ELEMENT_WEB_PORT` environment variable.
[Element Web Modules](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api) can be dynamically loaded [Element Web Modules](https://github.com/element-hq/element-web/tree/develop/packages/module-api) can be dynamically loaded
by being made available (e.g. via bind mount) in a directory within `/modules/`. by being made available (e.g. via bind mount) in a directory within `/modules/`.
The default entrypoint will be index.js in that directory but can be overridden if a package.json file is found with a `main` directive. The default entrypoint will be index.js in that directory but can be overridden if a package.json file is found with a `main` directive.
These modules will be presented in a `/modules` subdirectory within the webroot, and automatically added to the config.json `modules` field. These modules will be presented in a `/modules` subdirectory within the webroot, and automatically added to the config.json `modules` field.