• Elixir 83.7%
  • TypeScript 11.7%
  • CSS 2.7%
  • Rust 0.9%
  • Shell 0.5%
  • Other 0.5%
Find a file
2026-11-15 09:50:03 -05:00
.devcontainer Update dependencies 2026-10-01 10:02:05 -04:00
.githooks Remove once_cell dependency 2026-06-06 17:22:11 -04:00
.github skip redundant CI work 2026-11-06 19:15:46 -05:00
assets Merge pull request #796 from koloml/updated-properties-suggestions 2026-11-12 14:01:35 -05:00
config Adjust queue_target for test 2026-11-14 17:15:23 -05:00
docker Remove production web cache-control override 2026-11-11 12:03:58 -05:00
lib select distinct tag_change_ids 2026-11-15 09:05:42 -05:00
native/philomena comrak philomena-0.59.0.1 2026-11-06 19:15:17 -05:00
priv Name the internal rules migration with a generated timestamp 2026-11-06 22:38:13 +01:00
scripts update depends 2026-11-05 13:47:10 +01:00
test Support squashing of canceled tag and source changes 2026-11-14 18:21:33 -05:00
.credo.exs Move Philomena domain logic to contexts 2026-09-15 19:17:45 -04:00
.dialyzer_ignore.exs Move Philomena domain logic to contexts 2026-09-15 19:17:45 -04:00
.editorconfig Add switch_case_ident to .editorconfig to fix the defaults of shfmt (facehoof) 2025-04-06 20:03:27 +00:00
.formatter.exs initial 2019-08-14 20:32:32 -04:00
.gitattributes Make sure our frontend compiles with es2019 maximum (#553) 2025-05-07 10:53:35 +02:00
.gitignore Added root node_modules to .gitingore 2025-09-07 18:40:44 +04:00
.iex.exs run formatter 2020-01-10 23:20:19 -05:00
.prettierrc.yml Apply npm run fmt across the entire codebase 2025-03-16 23:26:36 +00:00
.sobelow-conf add and configure sobelow 2021-04-01 12:49:41 -04:00
.typos.toml update depends 2026-10-30 22:33:57 +01:00
AGENTS.md Update dependencies 2026-10-01 10:02:05 -04:00
CONTEXT_STYLE.md Upgrade ConcurrentDataCase to generalized unsandboxed test helper 2026-11-09 19:49:47 -05:00
docker-compose.yml update depends 2026-10-30 22:33:57 +01:00
LICENSE add totp & registration freeze 2019-08-17 18:06:11 -04:00
mix.exs Update version to 1.3.1 2026-11-15 09:39:45 -05:00
mix.lock update depends 2026-11-05 13:47:10 +01:00
openapi.yaml Keep post_id page jumps in the API post listing 2026-11-06 22:38:13 +01:00
package-lock.json deps update 2026-10-19 21:35:56 +02:00
package.json deps update 2026-10-19 21:35:56 +02:00
README.md Refresh dev instructions in README 2026-05-02 14:38:02 +00:00
rust-toolchain.toml update depends 2026-10-30 22:33:57 +01:00

Philomena

Philomena

Getting Started

Make sure you have Docker and Docker Compose plugin installed.

You can open this repo via a devcontainer in VSCode, JetBrains, GitHub Codespaces or any other supported IDE. This setup is the recommended way to develop and this way it's guaranteed everyone uses the same dev configs and dependencies.

If you can't/don't want to use devcontainers, then go through the docker/app/Dockerfile to see what dependencies/configurations you need to set up on your host machine.

Note that there are some additional Prerequisites for Remote SSH Development.

Dev Stack

Use the following commands to bring up or shut down the dev stack.

philomena up
philomena down

Once the application has started, navigate to http://localhost:8080 and log in with

Credential Value
Email admin@example.com
Password philomena123

Tip

See the source code of scripts/philomena.sh for details on the additional parameters and other subcommands.

Devcontainer Specifics

The devcontainer is configured with the docker-compose.yml. The IDE attaches to the app service of the stack. You can use docker compose to manage the stack but be careful not to shutdown the app service. Use philomena commands instead that make sure the app service is always running.

Prerequisites for Remote SSH Development

If you are developing on a remote SSH host that runs a devcontainer, then make sure to configure port forwarding like this:

Port Forwarded Address
web:80 localhost:80
5173 localhost:5173

Yes, use the host:port notation for web:80. It's because the web service runs in a separate container.

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)