History

ckerr 6eeeb3346e chore: update generated transmission-web files		2024-11-03 22:50:48 +00:00
..
assets	feat: display percent in progress bar for web client (#5937 )	2024-10-30 09:19:01 -05:00
public_html	chore: update generated transmission-web files	2024-11-03 22:50:48 +00:00
src	feat: display percent in progress bar for web client (#5937 )	2024-10-30 09:19:01 -05:00
.eslintrc.cjs	chore: convert `transmission-web` to ES module (#7209 )	2024-10-30 10:48:38 -05:00
.gitattributes	…
.nvmrc	…
CMakeLists.txt	build: use esbuild to bundle the web app (#6280 )	2023-11-27 19:23:40 -06:00
README.md	fix: update WebUI build instructions to use `dataurl` loader for images (#6430 )	2023-12-24 07:53:57 -06:00
esbuild.mjs	fix: esbuild load `svg` and `png` as `dataurl` type (#6409 )	2023-12-23 10:32:38 -06:00
generate-buildonly.js	fix: support nodejs below v20.11 for `generate_buildonly.js` (#7214 )	2024-10-31 22:15:05 -05:00
package-lock.json	build: use esbuild to bundle the web app (#6280 )	2023-11-27 19:23:40 -06:00
package.json	chore: convert `transmission-web` to ES module (#7209 )	2024-10-30 10:48:38 -05:00
package.json.buildonly	chore: update generated transmission-web files	2024-11-03 22:50:48 +00:00
prettier.config.cjs	chore: convert `transmission-web` to ES module (#7209 )	2024-10-30 10:48:38 -05:00
stylelint.config.cjs	chore: convert `transmission-web` to ES module (#7209 )	2024-10-30 10:48:38 -05:00

README.md

Transmission Web Client

A web interface is built into all Transmission flavors, enabling them to be controlled remotely.

Notes for Packagers

Building Without Node

Transmission includes a prebuilt webapp bundle in its releases. This is done because it's not easy to install the bundling tools on all of the platforms that Transmission supports. Debian can't use this prebuilt bundle due to its (understandable) policies that require building from source. Unfortunately, building with node run build is also problematic because of some of package.json's devDependencies aren't available as Debian packages.

Follow these steps to build the webapp from source on Debian without Node:

$ sudo apt install rsass perl esbuild
$ cd transmission/web/
$ rsass assets/css/transmission-app.scss > assets/css/transmission-app.css
$ perl -p -i -e 's/transmission-app.scss/transmission-app.css/' src/main.js
$ esbuild \
  --allow-overwrite \
  --bundle \
  --legal-comments=external \
  --loader:.png=dataurl \
  --loader:.svg=dataurl \
  --minify \
  --outfile=public_html/transmission-app.js \
  src/main.js

Notes for Developers

$ npm install
$ npm run dev

Navigate to localhost:9000 to run the app.

When you use npm run dev, the bundler will stay running in the background and will rebuild transmission-app.js whenever you change and save a source file. When it's done, you can reload the page in your browser to see your changes in action.

Notes for Testers

Use this bookmarklet to anonymize your torrent names before submitting a screenshot:

javascript:void%20function(){const%20a=document.getElementsByClassName(%22torrent-name%22);for(const%20b%20of%20a)console.log(b),b.textContent=%22Lorem%20ipsum%20dolor%20sit%20amet.iso%22}();