docker-compose
installed. Please refer to their manual to learn how to set up Docker and docker-compose./host
.docker-compose
, using docker-compose.dev.yml
instead of docker-compose.yml
. This is done by wrapping most developer mode commands using make
.aleph.env.tmpl
in the base directory. This is a template of the configuration file. Make a copy of this file named aleph.env
and define settings for your local instance. Check the configuration section for more information regarding the available options.docker run -it --rm --privileged --pid=host justincormack/nsenter1shell
.make all
to set everything up and launch the web service. This is equivalent to the following steps:make build
to build the docker images for the application and relevant services. You can run make docker-pull
before to pull pre-build release images.make upgrade
to run the latest database migrations and create/update the search index.make web
to run the web-based API server and the user interface.make worker
to start a worker. If you do not start a worker, background jobs (for example ingesting new documents) won’t be processed.http://localhost:8080/
in your browser to visit the web frontend.aleph
shell command is available (see Usage for details). You can also access the host computers file system at /host
. This means a file stored at /tmp/bla.txt
on your computer can be found at /host/tmp/bla.txt
inside the container.make worker
or inside an Aleph shell using aleph worker
.aleph createuser
command, inside a shell:ALEPH_ADMINS
environment variable (in your configuration) it will automatically be made into an admin.createuser
, the newly created user's API key is printed, which you can use in the Authorization
HTTP header of requests to the API. If you pass a password, you can use this email address and password to log into the web interface.ALEPH_SINGLE_USER
to true
. When you run Aleph in single-user mode, authentication is disabled and every user is automatically logged in as an admin user.crawldir
to index a small test data folder.make worker
to start a worker in your development environment. If you can’t see your sample data, make sure that you’re signed in, as your data won’t be public by default. See Users for instructions on how to create new user accounts.docker-compose
up and ready, run:make build
, which will build the alephdata/aleph
image (this will generate a production ready image).docker-compose
. See the FAQ page for information on not using Docker./aleph
). You are welcome to contribute fixes for this scenario.aleph.env
and define settings for your production instance. Check the section on configuration for more information regarding the available options.ALEPH_TAG
environment variable to specify the version of Aleph you want deploy. If ALEPH_TAG
is not set, the stable version specified in the docker compose file is deployed.8080
of its host machine and accept incoming connections. You can check that the system is functional with a curl request:http://localhost:8080
in your browser and use the web interface to navigate the application.ALEPH_DATABASE_URI
setting. * A database to store FtM entities. This database is defined by FTM_STORE_URI
. These two databases can use the same SQL database instance or can use separate instance for each use case.rsync
in a cron job to copy the directory to a backup server.)pg_dump
, pg_restore
and similar utilities.docker-compose run --rm shell aleph upgrade
to recreate the indices in Elasticsearchdocker-compose run --rm shell aleph reindex-full
to write data into Elasticsearch indices from the FtM-Store PostgreSQL database.This will take some time to run depending on how much data you have.aleph.env
, which is loaded by docker-compose and can modify many aspects of system behaviour. A template for the configuration with details regarding many of the options is available in the aleph.env.tmpl
file.ALEPH_SECRET_KEY
. A good example of a value is the output of openssl rand -hex 24
.ALEPH_UI_URL
.aleph/pages
directory.ALEPH_OAUTH_*
values.