Memento is a single-tenant, personal aggregator for information you “save” on different platforms, making that content searchable and partially backed up. Aggregation is automatic every 5 minutes.
It currently supports:
All data gets saved in a single Postgresql table (for easy search and backup).
The application scope is small, but one of the goals is to make it extremely robust, with all bells and whistles you need for production code.
Memento has four main components:
The Feed (implemented as a state machine via gen_statem) represents all common steps used to get data from any source:
What changes between two sources is how some specific steps are performed and this where the Handler comes in: defined as a behaviour, it’s implemented by every source in their own way, as all APIs are different.
The Memento.Capture module provides a top level api for manual operations (e.g. forcing a refresh).
All entries are stored on Postgresql.
config/config.exs, configuration options are documented there.
A copy of the documentation is available at https://memento-docs.surge.sh.
You will need a series of environment variables (for authentication against the sources APIs).
Once inside the container you can:
mix do deps.get, ecto.migrateto fetch elixir dependencies, compile and setup the db.
iex -S mix phx.serverto open an iex session with the running project (and then open http://localhost:4000)
mix testto run tests
The project is setup to deploy on Heroku, please make sure you:
mix escript.build will build a
memento cli executable in
./bin (which requires, to be executed, a working Erlang installation on the host machine) that can be used to browse a Memento instance from the command line.
Once built, you can call:
./bin/memento --base-url https://memento.my-site.com
For the full range of options, please call
Please note that the file can be safely moved and dropped in your
For ease of using, it's recommended to pipe the command to
less -r, which will paginate the results in glorious full colour.
./bin/memento --base-url https://memento.my-site.com | less -r