Simplify install documentation
Open
@k1o0 is already working on this.
Since Jul 21, 2026.
doc
enhancement
- Dominant language
- Python
- Stars
- 52
- Forks
- 12
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 4
Description
Currently the documentation informs users to clone Alyx then deploy containers that also contain Alyx. This is confusing and necessary. Instead users can deploy with just the compose file, perhaps after downloading via curl.
Some proposed changes:
- For production, users can download the compose file alone
- A requirements section should specify the minimum production OS version and drive space
- Instructions for poking around can instruct the user to clone the repo and compose the postgres container
- Document the release process in the contributing section of the readme
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.