mentos1386/send
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
send/README.md
Romain Hv a0bc20aeb6 Remove metrics #4
2021-03-15 19:56:51 +01:00

5.9 KiB
Raw Blame History

Send Send

Build status on GitLab CI Latest release Docker image Project license

A fork of Mozilla's Firefox Send. Mozilla discontinued Send, this fork is a community effort to keep the project up-to-date and alive.

  • Forked at Mozilla's last publicly hosted version
  • Mozilla & Firefox branding is removed so you can legally self-host
  • Kept compatible with ffsend (CLI for Send)
  • Dependencies have been updated
  • Mozilla's changes since the fork have been selectively merged
  • Mozilla's experimental report feature, download tokens, trust warnings and FxA changes are not included

Find an up-to-date Docker image here: docs/docker.md

The original project by Mozilla can be found here. The mozilla-master branch holds the master branch as left by Mozilla. The send-v3 branch holds the commit tree of Mozilla's last publicly hosted version, which this fork is based on. The send-v4 branch holds the commit tree of Mozilla's last experimental version which was still a work in progress (featuring file reporting, download tokens, trust warnings and FxA changes), this has selectively been merged into this fork. Please consider to donate to allow me to keep working on this.

Thanks Mozilla for building this amazing tool!

Docs: FAQ, Encryption, Build, Docker, More

Table of Contents

What it does

A file sharing experiment which allows you to send encrypted files to other users.

Requirements

Development

To start an ephemeral development server, run:

npm install
npm start

Then, browse to http://localhost:8080

Commands

Command Description
npm run format Formats the frontend and server code using prettier.
npm run lint Lints the CSS and JavaScript code.
npm test Runs the suite of mocha tests.
npm start Runs the server in development configuration.
npm run build Builds the production assets.
npm run prod Runs the server in production configuration.

Configuration

The server is configured with environment variables. See server/config.js for all options and docs/docker.md for examples.

Localization

Send localization is managed via Pontoon, not direct pull requests to the repository. If you want to fix a typo, add a new language, or simply know more about localization, please get in touch with the existing localization team for your language or Mozilla’s l10n-drivers for guidance.

see also docs/localization.md

Contributing

Pull requests are always welcome! Feel free to check out the list of "good first issues".

Deployment

see also docs/deployment.md

Clients

  • Web: this repository
  • Command-line: ffsend
  • Android: see Android section

Android

The android implementation is contained in the android directory, and can be viewed locally for easy testing and editing by running ANDROID=1 npm start and then visiting http://localhost:8080. CSS and image files are located in the android/app/src/main/assets directory.

License

Mozilla Public License Version 2.0

qrcode.js licensed under MIT