In tandem with #33, this ticket aims to compile more detailed information about the role each supporting technology plays in Reticulum. It is advised to read #33 first to get an overview of what will be reviewed here.
Currently, only the pre-installation dependencies (as defined in #33) have been seriously investigated, since they were the ones that gave me the most trouble when installing Reticulum.
Pre-Installation Dependencies
These dependencies are installed manually before beginning the Reticulum setup process.
Erlang & Elixir: Erlang and Elixir can almost be treated as one dependency, because they perform the same function: providing the programming language and runtime environment within which all of the Reticulum code runs.
Interacts With:.ex and .exs files, which are Elixir program files
Command Line Interface:
mix is the command used to run Mix tasks, which are used for managing the server, including installing dependencies (mix deps.get), compiling server code (mix ecto.create), and spinning the server up (mix phx.server). It is even possible to write custom Mix tasks for specialized use cases.
iex is used to run the Reticulum server in an interactive Elixir shell mode (iex -S mix phx.server), during which various Elixir commands can be used to examine the server status, make runtime changes, and pause or stop the service entirely.
PostgreSQL:PostgreSQL is used to interact with databases. It can be accessed through the psql command line interface, which opens up a special PSQL shell.
This documentation is a work-in-progress. More information about additional dependencies will be added as I learn about them.
Reticulum Dependencies - Details
In tandem with #33, this ticket aims to compile more detailed information about the role each supporting technology plays in Reticulum. It is advised to read #33 first to get an overview of what will be reviewed here.
Currently, only the pre-installation dependencies (as defined in #33) have been seriously investigated, since they were the ones that gave me the most trouble when installing Reticulum.
Pre-Installation Dependencies
These dependencies are installed manually before beginning the Reticulum setup process.
Erlang & Elixir: Erlang and Elixir can almost be treated as one dependency, because they perform the same function: providing the programming language and runtime environment within which all of the Reticulum code runs.
.ex
and.exs
files, which are Elixir program filesmix
is the command used to run Mix tasks, which are used for managing the server, including installing dependencies (mix deps.get
), compiling server code (mix ecto.create
), and spinning the server up(
mix phx.server
). It is even possible to write custom Mix tasks for specialized use cases.iex
is used to run the Reticulum server in an interactive Elixir shell mode (iex -S mix phx.server
), during which various Elixir commands can be used to examine the server status, make runtime changes, and pause or stop the service entirely.PostgreSQL: PostgreSQL is used to interact with databases. It can be accessed through the
psql
command line interface, which opens up a special PSQL shell.This documentation is a work-in-progress. More information about additional dependencies will be added as I learn about them.