Docs: FAQ, Encryption, Build, Docker, More
- What it does
- Requirements
- Development
- Commands
- Configuration
- Localization
- Contributing
- Testing
- Deployment
- License
A file sharing experiment which allows you to send encrypted files to other users.
Most of it's source code taken from abandoned Mozilla project Firefox Send, so basically icsend is a fork of Firefox Send. We greatly thanks for contributors to original project, and we will try to make your work get continued support.
Key difference between icsend and Firefox Send is that icsend targets mostly self-hosting approach. Most of the code related to tracking metrics, analytics and Firefox Account are removed.
It's currently in early stage of forking and adapting to new use case, so use it with care.
- Node.js 12.x
- Redis server (optional for development)
- AWS S3 or compatible service (optional)
To start an ephemeral development server, run:
npm install
npm startThen, browse to http://localhost:1337
| 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. |
The server is configured with environment variables. See server/config.js for all options and docs/docker.md for examples.
see also docs/deployment.md
Mozilla Public License Version 2.0