|
7 | 7 | * [Build and run in Firefox](#build-and-run-in-firefox)
|
8 | 8 | * [Build and manually install in Chromium](#build-and-manually-install-in-chromium)
|
9 | 9 | * [Run build on file changes](#run-build-on-file-changes)
|
| 10 | +* [Reproducible build in Docker](#reproducible-build-in-docker) |
10 | 11 | * [Useful tasks](#useful-tasks)
|
11 | 12 | * [Other tips](#other-tips)
|
| 13 | +* [Legacy Firefox (< 53) and XUL-compatible browsers](#legacy-firefox--53-and-xul-compatible-browsers) |
12 | 14 | * [Using IPFS Companion on Firefox for Android](#using-ipfs-companion-on-firefox-for-android)
|
13 | 15 | * [Install Firefox for Android](#install-firefox-for-android)
|
14 | 16 | * [Install IPFS Companion](#install-ipfs-companion)
|
@@ -85,6 +87,23 @@ npm run watch # watch for new changes
|
85 | 87 |
|
86 | 88 | **Note:** `watch` is a blocking command, so one needs to run it in a different terminal than `firefox` or `chromium`. Press ctrl+c to stop it.
|
87 | 89 |
|
| 90 | + |
| 91 | +## Reproducible build in Docker |
| 92 | + |
| 93 | +Want to ensure prebuilt bundle does not include any additional code? |
| 94 | +Don't want to install JS dependencies such as NodeJS and yarn? |
| 95 | + |
| 96 | +Do an isolated build inside of Docker! |
| 97 | + |
| 98 | +Run the following command for ending up |
| 99 | +with a built extension inside the `build/` directory: |
| 100 | + |
| 101 | +```sh |
| 102 | +npm run release-build |
| 103 | +``` |
| 104 | + |
| 105 | +It is an alias for running `ci:build` script inside of immutable Docker image, which guarantees the same output on all platforms. |
| 106 | + |
88 | 107 | ## Useful tasks
|
89 | 108 |
|
90 | 109 | Each `npm` task can run separately, but most of the time, `dev-build`, `test`, and `fix:lint` are all you need.
|
@@ -125,6 +144,11 @@ Release build shortcuts:
|
125 | 144 | - [Using localization in IPFS Companion](LOCALIZATION-NOTES.md) (running browsers with specific locale, etc)
|
126 | 145 | - [Testing persistent and restart features (Mozilla)](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Testing_persistent_and_restart_features)
|
127 | 146 |
|
| 147 | +## Legacy Firefox (< 53) and XUL-compatible browsers |
| 148 | + |
| 149 | +Legacy versions `1.x.x` were based on currently deprecated Add-On SDK (Firefox-only). |
| 150 | +While it is not maintained any more, one can inspect, build, and install it using codebase from [legacy-sdk](https://github.com/ipfs/ipfs-companion/tree/legacy-sdk) branch. For historical background on the rewrite, see [Issue #20: Move to WebExtensions](https://github.com/ipfs/ipfs-companion/issues/20). |
| 151 | + |
128 | 152 | ## Using IPFS Companion on Firefox for Android
|
129 | 153 |
|
130 | 154 | Firefox for Android is capable of running some of the same extensions as the desktop version. This makes it very useful for experimenting with IPFS.
|
|
0 commit comments