send README

The project's README from github.com/mozilla/send. As one markdown file: README.md.

Firefox Send

CircleCI

NOTICE - May 2021

Mozilla discontinued the Firefox Send service in September 2021. For more information about this, please see the Mozilla Blog.

Please note that the Mozilla Public License 2.0 does not "grant any rights in the trademarks, service marks, or logos of any Contributor." You may fork and modify the source code for Firefox Send pursuant to the Mozilla Public License, but you may not create a version of the service that uses Mozilla trademarks or logos.

This repository is archived. In May 2021, Mozilla removed Mozilla trademarks from some of the files in this repository so that developers using this code are less likely to inadvertently infringe Mozilla's trademarks and confuse users. You are welcome to copy and modify this code under its open source license, but please ensure that all use complies with Mozilla's trademark policy. In other words, if you create a new version of Firefox Send you must remove all "Mozilla" and "Firefox" branding to ensure that users are not confused about who is providing the service.

Docs: FAQ, Encryption, Build, Docker, Metrics, 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

Firefox 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".

Testing

ENVIRONMENT URL
Production https://send.firefox.com/
Stage https://stage.send.nonprod.cloudops.mozgcp.net/
Development https://send2.dev.lcip.org/

Deployment

see also docs/deployment.md

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

send (mozilla/send)

Searching Database…

13.2K ·GitHub
Send
archived
What is this?Firefox Send is a file sharing experiment from Mozilla (the makers of Firefox) that lets you send encrypted files to other users. Note that Mozilla shut the hosted service down and archived this repository.
So is this a website I host myself, or an app I install?It is a self-hosted web service: a Node.js 12.x backend with a browser frontend. There is also an Android client implementation in the android directory of the same repository.
How do I run my own instance?Install Node.js 12.x and run npm start for an ephemeral development server; for production run npm run build then npm run prod. Docker examples are documented in docs/docker.md.
Does it need Redis or S3 to run?Both are optional: Redis is only needed beyond development, and AWS S3 or any compatible storage service is optional too — so a minimal dev setup needs just Node.js.
Can I still use Firefox Send today?Not the hosted service — Mozilla discontinued Firefox Send in September 2021 and archived the repository in May 2021. The code is still there to fork and self-host, but nothing official is running or maintained.
If I fork it, what does the license let me do?It is Mozilla Public License 2.0, so you can fork and modify the code — but Mozilla trademarks are off-limits: any new version must remove all Mozilla and Firefox branding so users are not confused about who provides it.
Is there an Android app too?Yes — the repository contains an Android implementation in the android directory. You can preview it locally by running ANDROID=1 npm start and visiting the local URL; its CSS and image assets live under android/app/src/main/assets.
How does the file encryption actually work?The README only says Send lets you send encrypted files to other users and links a separate Encryption doc for details — the crypto scheme itself is not spelled out in the README.
How do I configure the server?Entirely through environment variables: every option is listed in server/config.js, and docs/docker.md shows configuration examples for Docker deployments.
What does the development workflow look like?Standard npm scripts: npm run format formats code with prettier, npm run lint runs eslint and stylelint, npm test runs the mocha suite, and npm start / npm run prod launch dev and production servers.
What are similar projects?filepizza, snapdrop, LibreChat, jevbox, cloudreve, flowsint, openGym, TREK
Which topics is it in?mpl, mozilla, file-upload, file-sharing, s3, redis, encryption, deprecated, docker-compose, web-app, android, privacy
Creator
mozilla
Size
63.1 MB
Stars
13.2K
Updated
CommitMay 21
Age
9y
Commits · 90 Days