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
archived
这是什么?Firefox Send 是 Mozilla(Firefox 的开发商)推出的一个文件分享实验项目,可以把加密后的文件发送给其他用户。注意:Mozilla 已经停止运营其托管服务,并归档了这个仓库。
那这是我自己搭建的网站,还是要安装的应用?它是一个可以自己搭建的网页服务:后端基于 Node.js 12.x,前端在浏览器里运行。同一个仓库的 android 目录里还有一个 Android 客户端实现。
怎么运行我自己的实例?安装 Node.js 12.x 并运行 npm start 即可启动一个临时开发服务器;生产环境则先运行 npm run build,再运行 npm run prod。Docker 示例见 docs/docker.md 文档。
运行它需要 Redis 或 S3 吗?两者都是可选的:Redis 只有在开发之外的场景才需要,AWS S3 或任何兼容的存储服务也是可选的——所以最简的开发环境只需要 Node.js。
现在还能用 Firefox Send 吗?官方托管服务不能用了——Mozilla 于 2021 年 9 月停止了 Firefox Send,并在 2021 年 5 月归档了仓库。代码还在,可以 fork 后自己搭建,但已经没有任何官方服务在运行或维护。
如果我 fork 它,许可证允许我做什么?它采用 Mozilla Public License 2.0,所以你可以 fork 并修改代码——但不能使用 Mozilla 的商标:任何新版本都必须去掉所有 Mozilla 和 Firefox 的品牌标识,以免用户搞不清服务由谁提供。
也有 Android 应用吗?有——仓库的 android 目录里就有 Android 实现。运行 ANDROID=1 npm start 并访问本地地址即可在本地预览;它的 CSS 和图片资源放在 android/app/src/main/assets 目录下。
文件加密具体是怎么实现的?README 只提到 Send 可以把加密文件发送给其他用户,并链接了一份单独的 Encryption 文档来介绍细节——加密方案本身在 README 里并没有说明。
服务器怎么配置?完全通过环境变量来配置:每个选项都列在 server/config.js 里,docs/docker.md 还提供了 Docker 部署的配置示例。
开发流程是什么样的?就是标准的 npm 脚本:npm run format 用 prettier 格式化代码,npm run lint 运行 eslint 和 stylelint,npm test 运行 mocha 测试,npm start / npm run prod 分别启动开发服务器和生产服务器。
What are similar projects?filepizza, snapdrop, LibreChat, jevbox, cloudreve, flowsint, openGym, TREK
Creator
mozilla
Size
63.1 MB
Stars
13.2K
Updated
CommitMay 21
Age
9y
Commits · 90 Days