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 закрыла хостинговый сервис и перевела этот репозиторий в архив.
Это сайт, который я размещаю сам, или приложение, которое я устанавливаю?Это веб-сервис для самостоятельного размещения (self-hosted): бэкенд на 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 или любой совместимый сервис хранения — тоже опция, так что для минимальной dev-настройки достаточно одного Node.js.
Могу ли я сегодня пользоваться Firefox Send?Хостинговый сервис — нет: Mozilla прекратила Firefox Send в сентябре 2021 года, а в мае 2021 перевела репозиторий в архив. Код на месте — можно сделать форк и разместить у себя, но ничего официального не работает и не поддерживается.
Если я сделаю форк, что мне разрешает лицензия?Это Mozilla Public License 2.0, так что вы можете делать форк и менять код — но товарные знаки Mozilla трогать нельзя: в любой новой версии нужно убрать все упоминания брендов Mozilla и Firefox, чтобы пользователи не путались в том, кто её предоставляет.
Есть ли приложение для Android?Да — в репозитории есть реализация для Android в каталоге android. Локально её можно посмотреть, запустив ANDROID=1 npm start и открыв локальный URL; её 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 запускают dev- и продакшен-серверы.
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