yutarohayakawa/elixir repository overview

⁠Elixir Docker Image

Elixir (http://elixir.free-electrons.com/⁠) is a wonderful cross referencer. However it is little difficult to setup, so I made Docker image for it.

⁠Example usage

⁠Running container

Download and run container.

$ mkdir projects
$ docker run --name elixir -p 8090:80 -v `pwd`/projects:/usr/local/elixir/http/projects -d yutarohayakawa/elixir

⁠Add new project to elixir

Add nginx (https://github.com/nginx/nginx⁠) project to elixir

$ docker exec elixir ./add_project -r https://github.com/nginx/nginx -n nginx

Please access http://localhost:8090/nginx/latest/source⁠ from your browser once its done.

Since container and host share projects directory and databases are made in there, you can reuse that volume from next time.

Note that the larger project which has large amount of source code or tags may takes very large amount of time to generate databases. According to the elixir's official document

Generating the full database can take a long time: it takes about 15 hours on a Xeon E3-1245 v5 to index 1800 tags in the Linux kernel. For that reason, you may want to tweak the script (for example, by limiting the number of tags with a "head") in order to test the update and query commands.

If you want to reduce the tag, you can specify -t option of add_project script like following

$ docker exec elixir ./add_project -r https://github.com/nginx/nginx -n nginx -t release-1.16.0,release-1.17.0

tag name should be comma separated.

If the project has no tags, add_project script automatically create a tag for latest source.