Find a file
liamwhite 4db83d5a27
Merge pull request #400 from philomena-dev/indexing-cli
Add reindexing command line with rate and time estimate
2025-01-18 12:13:08 -05:00
.github Force GH Actions workflows to use test env 2025-01-11 13:42:31 -05:00
assets Fix table > thead rule nesting 2025-01-12 09:21:30 -05:00
config Remove makefile indexer and improve Elixir-side indexing 2024-12-08 21:24:08 -05:00
docker Force GH Actions workflows to use test env 2025-01-11 13:42:31 -05:00
lib Add reindexing command line with rate and time estimate 2025-01-12 09:16:40 -05:00
native/philomena Unlock rust dependencies 2024-12-10 16:07:59 -05:00
priv migrate 2024-12-17 19:38:15 +01:00
test Add version 4 TypeScript-based FP calculation 2024-06-13 10:24:39 -04:00
.credo.exs Fix some credo issues 2024-06-24 23:23:43 -04:00
.dialyzer_ignore.exs Force GH Actions workflows to use test env 2025-01-11 13:42:31 -05:00
.dockerignore Use custom prebuilt ffmpeg 2021-12-12 13:43:22 -05:00
.editorconfig Add an .editorconfig file (#152) 2020-06-28 16:09:56 -04:00
.formatter.exs initial 2019-08-14 20:32:32 -04:00
.gitignore Add lexical to ignore list 2024-11-16 16:00:58 -05:00
.iex.exs run formatter 2020-01-10 23:20:19 -05:00
.sobelow-conf add and configure sobelow 2021-04-01 12:49:41 -04:00
.typos.toml Add typos workflow 2024-06-18 18:52:46 -04:00
docker-compose.yml Update container images 2025-01-10 12:27:59 -05:00
LICENSE add totp & registration freeze 2019-08-17 18:06:11 -04:00
mix.exs Force GH Actions workflows to use test env 2025-01-11 13:42:31 -05:00
mix.lock bump swoosh 2024-12-15 12:28:56 -05:00
post-receive add release conf for performing migrations 2020-08-17 18:49:44 -04:00
README.md Split out query features to PhilomenaQuery namespace 2024-06-03 21:08:33 -04:00

Philomena

Philomena

Getting started

On systems with docker and docker compose installed, the process should be as simple as:

docker compose build
docker compose up

If you use podman and podman-compose instead, the process for constructing a rootless container is nearly identical:

podman-compose build
podman-compose up

Once the application has started, navigate to http://localhost:8080 and login with admin@example.com / philomena123

Troubleshooting

If you are running Docker on Windows and the application crashes immediately upon startup, please ensure that autocrlf is set to false in your Git config, and then re-clone the repository. Additionally, it is recommended that you allocate at least 4GB of RAM to your Docker VM.

If you run into an OpenSearch bootstrap error, you may need to increase your max_map_count on the host as follows:

sudo sysctl -w vm.max_map_count=262144

If you have SELinux enforcing (Fedora, Arch, others; manifests as a Could not find a Mix.Project error), you should run the following in the application directory on the host before proceeding:

chcon -Rt svirt_sandbox_file_t .

This allows Docker or Podman to bind mount the application directory into the containers.

If you are using a platform which uses cgroups v2 by default (Fedora 31+), use podman and podman-compose.

Deployment

You need a key installed on the server you target, and the git remote installed in your ssh configuration.

git remote add production philomena@<serverip>:philomena/

The general syntax is:

git push production master

And if everything goes wrong:

git reset HEAD^ --hard
git push -f production master

(to be repeated until it works again)