azimuttapp / azimutt

Explore, document and optimize any database
https://azimutt.app
MIT License
1.36k stars 87 forks source link

Added Support for Dockerized Apple Silicon Installations - PR 311 Fix #314

Open MrKovar opened 4 months ago

MrKovar commented 4 months ago

Fix for issue 295: https://github.com/azimuttapp/azimutt/issues/295

When running the Dockerfile on Apple Silicon the container will crash with a "segmentation fault" caused by the elm binary not being compatible with the arm64 architecture. This updates the Dockerfile to use a new command --build-arg PLATFORM=<arm64/amd64> amd64 by default in the build instructions to build a container specifically for your platform.

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The changes include the addition of a PLATFORM variable for architecture specification in the .env.example, updates to the Dockerfile to support multi-architecture builds, and enhancements to the docker-compose.yml for dynamic platform settings. The INSTALL.md was also updated to cater specifically to Apple Silicon users. These modifications collectively improve the flexibility and usability of the application across different environments and hardware architectures.

Changes

Files Change Summary
.env.example New environment variable PLATFORM=amd64 added.
Dockerfile Introduced ELM_VERSION and PLATFORM arguments, restructured for multi-architecture (builder_amd64, builder_arm64) support, updated Node.js installation using NVM, adjusted COPY commands and directory permissions.
INSTALL.md Added instructions for Apple Silicon/Arm64 users for running the Azimutt application in Docker.
docker-compose.yml Changed platform from hardcoded linux/amd64 to dynamic reference linux/$PLATFORM and added args section for build arguments.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docker as Docker Environment
    participant App as Application
    User->>Docker: Run Docker with `--platform` flag
    Docker->>Docker: Build image using specified PLATFORM
    Docker->>App: Deploy application with correct architecture

🐇 "In the meadow where bunnies play,
A change in code brightens the day.
Platforms now dance, no need to fear,
With Elm and Node, the build is clear!
So hop along, let the builds take flight,
For every architecture, we'll code with delight!" 🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
MrKovar commented 3 months ago

Thanks for the reviews @SamirPS @loicknuchel ! I'll address them this evening and make things that are hard-coded easier to understand / made into a variable where necessary.

SamirPS commented 3 months ago

Thank @MrKovar

brandondrew commented 2 days ago

I would love to have this available to run on my Mac, in case the love I send your way happens to give any added motivation 💚😉