Skip to content

Commit 9a881e1

Browse files
Update README.md (#899)
* Update README.md * Update DEVELOPER-NOTES.md * Update DEVELOPER-NOTES.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md Node type prefs screenshot * Update README.md remove quotes * Update README.md on-off screenshot * Update README.md Power button loop * Update README.md Gateway redirect screenshot gif * Update README.md Per-site opt-out gif * Update README.md Update primary gif * Update README.md Remaining text rework * Update README.md Copy edits * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Update README.md Broken link * Update README.md Co-authored-by: Marcin Rataj <[email protected]> * Origin isolation text tweak Co-authored-by: Marcin Rataj <[email protected]>
1 parent 65a9763 commit 9a881e1

File tree

2 files changed

+117
-157
lines changed

2 files changed

+117
-157
lines changed

DEVELOPER-NOTES.md

+24
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
* [Build and run in Firefox](#build-and-run-in-firefox)
88
* [Build and manually install in Chromium](#build-and-manually-install-in-chromium)
99
* [Run build on file changes](#run-build-on-file-changes)
10+
* [Reproducible build in Docker](#reproducible-build-in-docker)
1011
* [Useful tasks](#useful-tasks)
1112
* [Other tips](#other-tips)
13+
* [Legacy Firefox (< 53) and XUL-compatible browsers](#legacy-firefox--53-and-xul-compatible-browsers)
1214
* [Using IPFS Companion on Firefox for Android](#using-ipfs-companion-on-firefox-for-android)
1315
* [Install Firefox for Android](#install-firefox-for-android)
1416
* [Install IPFS Companion](#install-ipfs-companion)
@@ -85,6 +87,23 @@ npm run watch # watch for new changes
8587

8688
**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.
8789

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+
88107
## Useful tasks
89108

90109
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:
125144
- [Using localization in IPFS Companion](LOCALIZATION-NOTES.md) (running browsers with specific locale, etc)
126145
- [Testing persistent and restart features (Mozilla)](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Testing_persistent_and_restart_features)
127146

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+
128152
## Using IPFS Companion on Firefox for Android
129153

130154
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

Comments
 (0)