Git Product home page Git Product logo

neutron's Introduction

neutron

Build Status

Self-hosted server for Protonmail client.

Demo: http://neutron.emersion.fr (username: neutron, passwords: neutron)

Keep in mind that Neutron is less secure than ProtonMail: most servers don't use full-disk encryption and aren't under 1,000 meters of granite rock in Switzerland. If you use Neutron, make sure to donate to ProtonMail!

The initial goal is to support IMAP & SMTP servers (authentication, messages and folders), storing everything else (contacts & settings) on disk. Neutron is modular so it's easy to create new backends and handle more scenarios.

Install

Options

  • -config: specify a custom config file
  • -help: show help

Configuration

See config.json.

{
	"Memory": {
		"Enabled": true,
		"Populate": false,
		"Domains": ["emersion.fr"] // Available e-mail domains
	},
	"Imap": { // IMAP server config
		"Enabled": true,
		"Hostname": "mail.gandi.net",
		"Suffix": "@emersion.fr"
	},
	"Smtp": { // SMTP server config
		"Enabled": true,
		"Hostname": "mail.gandi.net",
		"Port": 587,
		"Suffix": "@emersion.fr"
	},
	"Disk": { // Store keys, contacts and settings on disk
		"Enabled": true,
		"Keys": { "Directory": "keys" },
		"Contacts": { "Directory": "contacts" },
		"UsersSettings": { "Directory": "users" }
	}
}

To add a new user, just click Sign up on the login page and enter your IMAP credentials.

One field per backend, each one containing a boolean Enabled to turn it on or off.

  • Memory: stores all data in memory. Set Populate to true to automatically populate memory with some data (username: neutron, passwords: neutron).
  • Imap: stores messages on an IMAP server
  • Smtp: sends messages via a SMTP server
  • Disk: store all data on disk

Build

Requirements:

  • Go (to build the server)
  • Node, NPM (to build the client)
# Get the code
go get -u github.com/emersion/neutron
cd $GOPATH/src/github.com/emersion/neutron

# Build the client
git submodule init
git submodule update
make build-client

# Start the server
make start

Backends

All backends must implement the backend interface. The main backend interface is split into multiple other backend interfaces for different roles: ContactsBackend, LabelsBackend and so on. This allows to build modular backends, e.g. a MessagesBackend which stores messages on an IMAP server with a ContactsBackend which stores contacts on a LDAP server and a SendBackend which sends outgoing messages to a SMTP server.

Writing a backend is just a matter of implementing the necessary functions. You can read the memory backend to understand how to do that. Docs for the backend are available here: https://godoc.org/github.com/emersion/neutron/backend#Backend

License

MIT

neutron's People

Contributors

emersion avatar

Watchers

James Cloos avatar Johnson Chetty avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.