docker-compose.yml. This is done by wrapping most developer mode commands using
aleph.env.tmplin the base directory. This is a template of the configuration file. Make a copy of this file named
aleph.envand define settings for your local instance. Check the configuration section for more information regarding the available options.
make allto set everything up and launch the web service. This is equivalent to the following steps:
make buildto build the docker images for the application and relevant services. You can run
make docker-pullbefore to pull pre-build release images.
make upgradeto run the latest database migrations and create/update the search index.
make webto run the web-based API server and the user interface.
make workerto 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.
alephshell 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.txton your computer can be found at
/host/tmp/bla.txtinside the container.
aleph createusercommand, inside a shell:
createuser, the newly created user's API key is printed, which you can use in the
AuthorizationHTTP 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.
true. When you run Aleph in single-user mode, authentication is disabled and every user is automatically logged in as an admin user.
crawldirto index a small test data folder.
make workerto 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-composeup and ready, run:
make build, which will build the
alephdata/alephimage (this will generate a production ready image).
/aleph). You are welcome to contribute fixes for this scenario.
ALEPH_TAGenvironment variable to specify the version of Aleph you want deploy. If
ALEPH_TAGis not set, the stable version specified in the docker compose file is deployed.
8080of its host machine and accept incoming connections. You can check that the system is functional with a curl request:
http://localhost:8080in your browser and use the web interface to navigate the application.
ALEPH_DATABASE_URIsetting. * 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.
rsyncin a cron job to copy the directory to a backup server.)
pg_restoreand similar utilities.
docker-compose run --rm shell aleph upgradeto recreate the indices in Elasticsearch
docker-compose run --rm shell aleph reindex-fullto 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_SECRET_KEY. A good example of a value is the output of
openssl rand -hex 24.