Skip to content

Documentation, Docker Improvements & Bug Fix#2

Open
phessophissy wants to merge 13 commits intoalexgo-io:mainfrom
phessophissy:main
Open

Documentation, Docker Improvements & Bug Fix#2
phessophissy wants to merge 13 commits intoalexgo-io:mainfrom
phessophissy:main

Conversation

@phessophissy
Copy link
Copy Markdown

Documentation, Docker Improvements & Bug Fix

Description

This PR adds comprehensive documentation, improves Docker configuration, and fixes a typo in the repository.

Changes

🐛 Bug Fix

  • Fixed typo postresqlpostgresql in restore-archive-pg.sh

📚 Documentation

File Description
LICENSE Added MIT license
CONTRIBUTING.md Contribution guidelines
TROUBLESHOOTING.md Common issues and solutions
README.md Improved with prerequisites, commands table, and structure

🐳 Docker Improvements

File Description
.env.example Environment variable reference
docker-compose.override.yml.example Docker customization template
Makefile Common operations (make start, make stop, make health, etc.)
health-check.sh Script to monitor node sync status
.gitignore Updated with common patterns

Summary

  • 10 commits
  • 10 files changed
  • +377 additions, -37 deletions

Checklist

  • Typo fixed and tested
  • Documentation is clear and helpful
  • Scripts are executable
  • No breaking changes to existing functionality
  • Follows existing code style

Testing

  • Scripts have been reviewed for syntax errors
  • Makefile targets are consistent with existing scripts
  • Documentation links verified

@mhatal
Copy link
Copy Markdown
Collaborator

mhatal commented Mar 11, 2026

Thank you for contributing! And sorry for the late response. Before it can be merged, make sure it does not affect existing deployments.

And please:

  1. remove the license for now, we'll add it later
  2. if you're adding support to use different database password, you probably need to update the restore script to change the password after restoring from the archive

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants