Skip to content

Commit 58c5224

Browse files
authored
Emphasise self-hosting and support in project README. (#211)
1 parent 82b811b commit 58c5224

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ orra coordinates tasks across your existing stack, agents and any tools run as s
3333
- [Explore Examples](#explore-examples)
3434
- [Docs](#docs)
3535
- [Self Hosting](#self-hosting)
36-
- [Join Our Alpha Testing Community](#join-our-alpha-testing-community)
36+
- [Support](#support)
3737
- [License](#license)
3838

3939
## Installation
@@ -247,22 +247,20 @@ The Plan Engine ensures:
247247

248248
## Self Hosting
249249

250-
1. **Storage**: We use BadgerDB to persist all state
251-
2. **Deployment**: Single-instance only, using containers designed for development and self-hosted deployments
250+
The orra Plan Engine is packaged with a [Dockerfile](planengine/Dockerfile). Run it a single instance locally using docker or docker compose.
252251

253-
## Join Our Alpha Testing Community
252+
**For production**, run the Plan Engine as single instance on a Cloud Service like [Digital Ocean](https://docs.digitalocean.com/products/app-platform/how-to/deploy-from-monorepo/) by pointing to the `planengine` folder during setup.
254253

255-
**We're looking for developers who:**
254+
The Plan Engine uses the [BadgerDB](https://github.com/hypermodeinc/badger) embedded database to persist all state - operational information is queryable using the [orra CLI](docs/cli.md).
256255

257-
- Are building multi-agent applications
258-
- Want to help shape orra's development
259-
- Are comfortable working with Alpha software
260-
- Can provide feedback on real-world use cases
256+
[Book an office hours slot](https://cal.com/orra-dev/office-hours), to get help hosting or running orra's Plan Engine for production.
261257

262-
**Connect With Us:**
258+
## Support
263259

264-
- [GitHub Discussions](https://github.com/orra-dev/orra/discussions) - Share your experience and ideas
265-
- [Office Hours](https://cal.com/orra-dev/office-hours) - Weekly calls with the team every Friday
260+
Need help? We're here to support you:
261+
262+
- Report a bug or request a feature by creating an [issue](https://github.com/orra-dev/orra/issues/new?template=bug-report-feature-request.yml)
263+
- Start a [discussion](https://github.com/orra-dev/orra/discussions) about your ideas or questions
266264

267265
## License
268266

0 commit comments

Comments
 (0)