Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation/README #126

Closed
mattbell87 opened this issue Mar 22, 2024 · 2 comments · Fixed by #127
Closed

Documentation/README #126

mattbell87 opened this issue Mar 22, 2024 · 2 comments · Fixed by #127
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mattbell87
Copy link
Member

mattbell87 commented Mar 22, 2024

Readme.md needs to be changed to include or link to more info:

  • Instructions for developing (rework the current info?)
    • Docker compose file is for development, how to get started
    • Explain how volumes are mapped with the compose file
    • Execute cmfive.php with the container docker compose exec -it webapp php cmfive.php
    • Running playwright and phpunit
    • Remove or update mkcert info? (any objection to just letting people ignore warnings?)
  • Docker image details
    • Environment variables
      • DB_HOST
      • DB_DATABASE
      • DB_USERNAME
      • DB_PASSWORD
      • ENVIRONMENT
    • Build args
      • CORE_BRANCH
      • PHP_VERSION
    • Volumes to mount in /var/www/html for persistence
      • ./storage
      • ./uploads
      • ./backups
    • Ports
      • 80
      • 443
    • SSL/TLS Certificate mounting
      • Mention the self signed certificate that's built in to the image and how to override it (another volume mount)
  • Instructions for deploying cmfive
    • Docker
    • CDK?
    • Manual Nginx/Apache/PHP/MySQL etc
@mattbell87 mattbell87 added the documentation Improvements or additions to documentation label Mar 22, 2024
@chris-bateman
Copy link
Member

A good read here for what to potentially include.
https://opensource.guide/

Think about another person using this project from scratch.

@chris-bateman
Copy link
Member

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants