Skip to content

Improved README explanation for beginners #984

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.

Sign up for GitHub

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

Open
akashnath-2000 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improved README explanation for beginners #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f244832
Improved README explanation for beginners
akashnath-2000 May 19, 2026
46ee8e2
Added beginner-friendly Dockerfile explanations
akashnath-2000 May 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion Dockerfile.custom
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ ARG VERSION=4.0.0
# Changing base OS for Geodesic is possible by changing this arg, but
# unfortunately, the package managers are different, so it is not that simple.
ARG OS=debian

# ARG values are available during image build time only.
# ENV values remain available inside the running container.
FROM cloudposse/geodesic:$VERSION-$OS
# Uses the Geodesic Docker image as the base image for customization.

ENV DOCKER_IMAGE="examplecorp/infrastructure"
ENV DOCKER_TAG="latest"
Expand Down Expand Up @@ -58,5 +60,7 @@ RUN apt-get update && apt-get install kubectl-${KUBECTL_VERSION}
RUN apt-get install atmos

COPY rootfs/ /
# Copies local rootfs files into the container filesystem.

WORKDIR /workspace
# Sets /workspace as the default working directory inside the container.
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,8 @@ Launching Geodesic is a bit complex, so we recommend you install a launch script
```
docker run --rm cloudposse/geodesic:latest-debian init | bash
```
This command installs the Geodesic launcher locally using Docker.

After that, you should be able to launch Geodesic just by typing
```
geodesic
Expand Down Expand Up @@ -323,6 +325,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Join our [Open Source Community](https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/geodesic&utm_content=slack) on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.


### 📰 Newsletter

Sign up for [our newsletter](https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/geodesic&utm_content=newsletter) and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know.
Expand Down
Loading