aaanh/linux-docs repository overview

⁠unix.hoanganh.tech

Rationale for this project: I got tired of Googling every time I do out-the-box setup an Ubuntu installation or VM.

The project is not intended for multi-hosts and orchestration scenarios, but for end-user semi-manual setups. However, in the future I do want to utilize orchestration tools for these tasks.

⁠Deployment

This repository CI is set up using GitHub Actions:

• Trigger build and deployment when pushed to prod branch.
• Deploy to a Debian server hosted on Linode.

⁠Local Development

⁠Native

• Requires python>=3.8 and pip.
• Install dependencies: pip install -r requirements.txt.
• Navigate to ./build/html and view index.html with your favorite browser.
• OR serve the ./build/html folder with a simple http server.

⁠Docker Container

⁠Non-multistage

• docker build . -t linux-docs:dev
• docker run -dp 3000:80 linux-docs --name linux-docs-test
• Navigate to localhost:3000 on local browser.

⁠Multistage

• docker build -t linux-docs:multistage -f Docker-multistage .
• docker run -dp 8080:80 linux-docs:multistage --name linux-docs-multistage
• Navigate to localhost:8080 on local browser.

⁠Contributions

• Fork the repository
• Do your thing
• Commit with meaningful description
• Push to your fork repository
• Create pull request

⁠Updates

⁠2022/04/18

Refactoring of topics and entries has commenced.

⁠2022/03/22

Web server has been migrated from Apache2 to Nginx.