From 862398c00e17d8e126c4fc4403264391c2fe5aff Mon Sep 17 00:00:00 2001 From: Andrew Ferrazzutti Date: Thu, 6 May 2021 02:58:27 -0400 Subject: [PATCH] Update READMEs with xvfb instructions (and more) --- ROADMAP.md | 1 - SETUP.md | 46 ++++++++++++++++++++++++++++++++-------------- puppet/README.md | 11 ++++++++++- 3 files changed, 42 insertions(+), 16 deletions(-) diff --git a/ROADMAP.md b/ROADMAP.md index af3c88c..ac41525 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -63,7 +63,6 @@ * [x] Use bridge bot for messages sent from LINE app (when double-puppeting is disabled and `bridge.invite_own_puppet_to_pm` is enabled) * [x] Use own Matrix account for messages sent from LINE app (when double-puppeting is enabled) * [x] E2EE in Matrix rooms - * [ ] No display required for Puppeteer-controlled browser * [ ] Multiple bridge users * [ ] Relay bridging diff --git a/SETUP.md b/SETUP.md index d8fee3a..a94a3a7 100644 --- a/SETUP.md +++ b/SETUP.md @@ -2,18 +2,36 @@ * Python 3.8 * Node 10.18.1 -# Setup +# Initial setup +## Puppeteer module 1. Download the .crx file of the [LINE Chrome extension](https://chrome.google.com/webstore/detail/line/ophjlpahpchlmihnnnihgmmeilfjmjjc) (version 2.4.4), and extract it to `puppet/extension_files` -2. `cd` to the `puppet` directory and run `yarn --production` -3. Run `node prep_helper.js` to open the version of Chrome downloaded by Puppeteer, and click on the LINE icon next to the URL bar -4. Once the LINE popup appears, press F12 to show DevTools, which will reveal the LINE extension's UUID -5. Copy `puppet/example-config.json` to `puppet/config.json`, and update it with the UUID found in the previous step -6. Launch the Puppeteer module with `yarn start` or `node src/main.js` -7. `cd` to the main directory and create a Python virtual environment with `virtualenv -p /usr/bin/python3 .venv`, and enter it with `source .venv/bin/activate` -8. Install Python requirements: - * `pip install -r requirements.txt` for base functionality - * `pip install -r optional_requirements.txt` for [end-to-bridge](https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html) encryption and metrics -9. Copy `matrix_puppeteer_line/example-config.yaml` to `config.yaml`, and update it with the proper settings to connect to your homeserver -10. Run `python -m matrix_puppeteer_line -g` to generate an appservice registration file, and update your homeserver configuration to accept it -11. Run the bridge with `python -m matrix_puppeteer_line` -12. Start a chat with the bot and follow the instructions +1. `cd` to the `puppet` directory and run `yarn --production` +1. Run `node prep_helper.js` to open the version of Chrome downloaded by Puppeteer, and click on the LINE icon next to the URL bar +1. Once the LINE popup appears, press F12 to show DevTools, which will reveal the LINE extension's UUID +1. Copy `puppet/example-config.json` to `puppet/config.json`, and set some important settings: + * set `"url"` to the UUID found in the previous step + * set the `"listen"` settings to the socket to use for communication with the bridge (see [puppet/README.md](puppet/README.md) for details) + +## Bridge +1. `cd` to the project root directory and create a Python virtual environment with `python -m venv .venv`, and enter it with `source .venv/bin/activate` +1. Install Python requirements: + * `pip install -Ur requirements.txt` for base functionality + * `pip install -Ur optional_requirements.txt` for [end-to-bridge](https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html) encryption and metrics +1. Copy `matrix_puppeteer_line/example-config.yaml` to `config.yaml`, and update it with the proper settings to connect to your homeserver + * In particular, be sure to set the `puppeteer.connection` settings to use the socket you chose in `puppet/config.json` +1. Run `python -m matrix_puppeteer_line -g` to generate an appservice registration file, and update your homeserver configuration to accept it + +# Running +1. In the `puppet` directory, launch the Puppeteer module with `yarn start` or `node src/main.js` +1. In the project root directory, run the bridge with `python -m matrix_puppeteer_line` +1. Start a chat with the bot and follow the instructions + +# Running the Puppeteer module headless +Puppeteer cannot be run in headless mode when using Chromium with extensions (including the LINE extension). + +As a workaround, it may be run in a background X server. This allows running the Puppeteer module on a GUI-less server. + +An easy way to do so is to install `xvfb` from your distribution, and run the Puppeteer module with `xvfb-run yarn start`. + +# Upgrading +Simply `git pull` or `git rebase` the latest changes, and rerun any installation commands (`yarn --production`, `pip install -Ur ...`). diff --git a/puppet/README.md b/puppet/README.md index cf1efdd..d10d193 100644 --- a/puppet/README.md +++ b/puppet/README.md @@ -4,4 +4,13 @@ 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. ### Profile directory -The `profile_dir` specifies which directory to put chromium user data directories. +The `profile_dir` specifies which directory to put Chromium user data directories. + +### URL +`url` specifies the URL of the index page of the LINE extension for your Chromium installation. + +### Extension directory +The `extension_dir` specifies which directory contains the files for the LINE extension, which you must download yourself. + +### DevTools +Set `devtools` to `true` to launch Chromium with DevTools enabled by default.