yuessir
/
matrix-puppeteer-line
forked from fair/matrix-puppeteer-line
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
matrix-puppeteer-line/puppet/README.md

28 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

Add config and improve stopping
2020-08-24 09:45:44 -04:00
### Listen config
If `type` is `unix`, `path` is the path where to create the socket.
If `type` is `tcp`, `port` and `host` are the host/port where to listen.
Add config for setting custom Chromium path Also update SETUP/README with instructions
2021-07-03 01:54:19 -04:00
### Executable path
The `executable_path` specifies the path to the Chromium binary for Puppeteer to use. Leaving this setting blank will use the x86_64 Chromium installation bundled with Puppeteer. For other architectures, it is necessary to install a compatible version of Chromium (ideally via your distribution's package manager), and to set `executable_path` to the path of its binary (typically `/usr/bin/chromium`).
Fix sandboxing - Allow setting the sandbox in the config file, and document it - Enable the sandbox in the default Docker config - Don't assign to a const when trying to set the sandbox flag
2022-05-03 22:56:55 -04:00
### Sandbox
Whether or not to pass the `--no-sandbox` flag to Chromium. May be required when running Chromium in a container.
Add config and improve stopping
2020-08-24 09:45:44 -04:00
### Profile directory
Update READMEs with xvfb instructions (and more)
2021-05-06 02:58:27 -04:00
The `profile_dir` specifies which directory to put Chromium user data directories.
### Extension directory
The `extension_dir` specifies which directory contains the files for the LINE extension, which you must download yourself.
Jiggle mouse with xdotool to keep LINE alive Even if Chrome is the only window in an X session, and even if the window is focused, the LINE extension stops getting new messages unless the mouse has moved recently. To work around that, use xdotool to move the mouse every so often.
2021-07-01 01:49:43 -04:00
### Cycle delay
Allow disabling chat cycling
2021-10-14 20:49:46 -04:00
`cycle_delay` specifies the period (in milliseconds) at which Puppeteer should view chats to check on their read receipts. Only chats with messages that haven't been fully read need to be checked. Set to a negative value to disable this checking.
Jiggle mouse with xdotool to keep LINE alive Even if Chrome is the only window in an X session, and even if the window is focused, the LINE extension stops getting new messages unless the mouse has moved recently. To work around that, use xdotool to move the mouse every so often.
2021-07-01 01:49:43 -04:00
### `xdotool`
Update docs
2021-07-02 14:02:46 -04:00
Set `use_xdotool` to `true` to allow the Node process to manipulate the mouse cursor of the X server it runs in. Requires the `xdotool` utility to be installed. Highly recommended, especially when running in a background X server. Its default value is `false` so that running in a non-background X server won't interfere with a real mouse cursor.
Jiggle mouse with xdotool to keep LINE alive Even if Chrome is the only window in an X session, and even if the window is focused, the LINE extension stops getting new messages unless the mouse has moved recently. To work around that, use xdotool to move the mouse every so often.
2021-07-01 01:49:43 -04:00
Update docs
2021-07-02 14:02:46 -04:00
`jiggle_delay` specifies the period (in milliseconds) for "jiggling" the mouse cursor (necessary to keep the LINE extension active). Only relevant when `use_xdotool` is `true`.
Jiggle mouse with xdotool to keep LINE alive Even if Chrome is the only window in an X session, and even if the window is focused, the LINE extension stops getting new messages unless the mouse has moved recently. To work around that, use xdotool to move the mouse every so often.
2021-07-01 01:49:43 -04:00
Update READMEs with xvfb instructions (and more)
2021-05-06 02:58:27 -04:00
### DevTools
Set `devtools` to `true` to launch Chromium with DevTools enabled by default.