ElixirNote Server
TOC
Introduction
Elixr Server is the backend -- the core services, APIs, and REST endpoints -- to Elixir web applications.
Elixir Server is a replacement for the Tornado Web Server in Notebook. Elixir web applications should move to use Elixir Server.
Who's this for?
The Elixir Server is a highly technical piece of the Elixir Stack, so we've separated documents to help specific personas:
Users: people using Elixir web applications.
Operators: people deploying or serving Elixir web applications to others.
Developers: people writing Elixir Server extensions and web applications.
If you find gaps in the documents, please open an issue (or better, a pull request) on the Elixir Server GitHub repo.
User
Installation
To install the latest release locally, make sure you have pip installed and run:
Configurate the Elixir Server
Using an Elixir config file
By default, Elixir Server looks for server-specific configuration in a elixir_server_config file located on a Elixir path. To list the paths where Elixir Server will look, run:
In Python files, these traits will have the prefix c.ServerApp. For example, your configuration file could look like this:
Using the CLI
Alternatively, you can configure Elixir Server when launching from the command line using CLI args. Prefix each argument with --ServerApp like so:
Launching a bare Elixir Server
Most of the time, you won't need to start the Elixir Server directly. Elixir web applications come with their own entry points that start a server automatically.
Sometimes, though, it can be useful to start Elixir Server directly when you want to run multiple Elixir web applications at the same time, you can simple run the following:
Operators
Managing multiple extensions
Configuring Extensions
Migrating from Notebook Server
Running a public Elixir Server
Security in the Elixir Server
Configuring Logging
Developers
Architecture Diagrams
Depending on Elixir Server
The REST API
Server Extensions
File save hooks
Content API
WebSocket kernel wire protocols
FAQ
Last updated