Skip to content

docs: Floci as the default emulator, with a seeded Docker Compose example - #161

Merged
DaviReisVieira merged 3 commits into
DaviReisVieira:mainfrom
hectorvent:docs/floci-example
Sep 14, 2026
Merged

DaviReisVieira merged 3 commits into
DaviReisVieira:mainfrom
hectorvent:docs/floci-example

Conversation

@hectorvent

@hectorvent hectorvent commented Sep 10, 2026 •

Copy link
Copy Markdown
Contributor

Floci serves its whole AWS surface on port 4566, so StackPort works against it with AWS_ENDPOINT_URL alone. This PR makes Floci the default emulator and adds a seeded Compose example for it.

Compose example (examples/docker-compose.floci.yml)

  • Runs Floci, StackPort, and a one-shot seed container creating S3, SQS, SNS, DynamoDB, Secrets Manager, IAM, Logs and Step Functions resources, so the dashboard is populated on first load
  • The seed is safe to re-run: it writes a .seeded marker last and skips when it is present, and a create helper treats "already exists" as success so a run that failed halfway is retried rather than skipped
  • Hybrid storage is persisted in a named floci-data volume
  • Docker socket is opt-in and commented out. user: root is not needed, the image entrypoint already drops to the floci user
  • Queue, topic and role ARNs are captured from the CLI instead of hardcoding the account id

Default emulator

  • Root docker-compose.yml runs Floci instead of MiniStack and relies on the image's built-in healthcheck
  • README Quick Start starts Floci with docker run -d. MiniStack keeps its own Compose example and moves to the alternatives list
  • CLAUDE.md, CONTRIBUTING, the bug report template, the Docker Hub short description, the VS Code extension README and manifest, and the pyproject keywords now mention Floci

Verified locally: fresh up, a second up (seed skips), down then up (state survives in the volume), and a retry after a simulated partial seed. All 35 services probe with no errors.

hectorvent and others added 3 commits September 10, 2026 17:26
Floci serves its whole AWS surface on port 4566, so StackPort works
against it with AWS_ENDPOINT_URL alone.

- examples/docker-compose.floci.yml runs Floci, StackPort, and a one-shot
  seed container creating S3, SQS, SNS, DynamoDB, Secrets Manager, IAM,
  Logs and Step Functions resources, so the dashboard is populated on the
  first load
- README gains a "Docker Compose (Floci + StackPort)" section and names
  Floci in Quick Start and the feature list
Compose example:
- seed is idempotent (skips when the demo bucket exists) so a second
  `docker compose up` no longer fails on ResourceInUseException
- persist hybrid storage in a named volume instead of an anonymous one
- Docker socket is opt-in; drop `user: root` (the image's entrypoint
  already starts as root and drops to the floci user via gosu)
- capture queue, topic and role ARNs from the CLI instead of hardcoding
  the account id; drop FLOCI_BASE_URL, FLOCI_HOSTNAME is sufficient

Default emulator:
- root docker-compose.yml runs Floci
- README Quick Start uses `docker run -d` for Floci; MiniStack moves to
  the alternatives list and keeps its own compose example
- CLAUDE.md, CONTRIBUTING, bug report template, Docker Hub description,
  VS Code extension README and pyproject keywords mention Floci
- write a `.seeded` marker last and key the skip on it, so a run that
  failed halfway is retried instead of skipped forever
- `create` helper treats "already exists" as success and fails on
  anything else, which lets a retry get past completed steps
- drop `-x` so the demo secret is not echoed into the seed logs
- take the queue URL from create-queue instead of a second lookup
- point the usage hint at `logs seed` when the dashboard is empty
- README: the MiniStack compose file is a minimal variant, not "the
  same setup"; link the canonical ministackorg repo in both READMEs
- VS Code extension marketplace description mentions Floci
@DaviReisVieira DaviReisVieira changed the title docs: add a Floci + StackPort Docker Compose example docs: Floci as the default emulator, with a seeded Docker Compose example Sep 14, 2026
@DaviReisVieira
DaviReisVieira merged commit e83aa2f into DaviReisVieira:main Sep 14, 2026
2 checks passed
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