Skip to content
This repository has been archived by the owner on Sep 28, 2024. It is now read-only.

Commit

Permalink
update readme (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugodutka authored Jul 10, 2023
1 parent b5cc65f commit 4ec00d4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@
<a href="https://hocus.dev/">Website</a> - <a href="https://hocus.dev/docs">Docs</a> - <a href="https://github.com/hocus-dev/hocus/issues/new/choose">Bug report</a> - <a href="https://join.slack.com/t/hocus-dev/shared_invite/zt-1yhsrtd84-lL7~bPl1Rd~_ZqVBzp2Ycg">Slack</a>
</p>

**Hocus** is a self-hosted application that spins up ready-to-code, disposable development environments on your own servers in seconds. You define your dev environments as code and launch them instantly from your browser. It's a **self-hosted alternative** to **Gitpod** and **Github Codespaces**.
**Hocus** is a self-hosted application that spins up ready-to-code, disposable development environments on your own servers in seconds. You define your dev environments as code and launch them instantly from your browser. It's a **self-hosted alternative** to **Gitpod** and **GitHub Codespaces**.

Hocus integrates with any Git provider that uses the SSH protocol, like GitHub, GitLab, BitBucket, or Gitea. It prebuilds dev environments on every commit for all branches like a CI system, enabling your team members to start coding with fresh, fully configured dev environments right away. Whether you're fixing a bug, building a new feature, or conducting a code review, Hocus has you covered.

## Features

![hocus-demo-3](https://user-images.githubusercontent.com/28019628/227723898-09a9ac73-ab36-4fb2-a008-ce81e047bb7a.gif)

- 💻 **Workspaces** - disposable, fully-configured development environments powered by [Firecracker](https://github.com/firecracker-microvm/firecracker) micro VMs, defined as code.
- 💻 **Workspaces** - disposable, fully-configured development environments powered by VMs, defined as code.
- 🏗️ **Prebuilds** - Hocus continuously builds your project like a CI system, so you can spin up a fresh dev environment in seconds and focus on coding rather than waiting.
- 🤝 **Project Environment Variables** - Declare shared environment variables for your entire team, making collaboration easier.
- 🔗 **VSCode Integration** - Connect to workspaces over SSH automatically with your local VSCode editor.
- 🧙‍♂️ **Full Root Access** - Unlike Docker containers, Hocus workspaces are full-fledged VMs, giving you full control over your environment. You can use Docker and nested KVM, run [LocalStack](https://github.com/localstack/localstack), or even deploy [Kubernetes](https://github.com/kubernetes/kubernetes);
- 🔄 **Support for any Git provider that uses the SSH protocol** - Connect Hocus to Github, Gitlab, Bitbucket, Gitea, Gerrit, and others.
- 🔄 **Support for any Git provider that uses the SSH protocol** - Connect Hocus to GitHub, Gitlab, Bitbucket, Gitea, Gerrit, and others.
- 🚄 **Monorepo support** - Create multiple development environments for different projects in a single repository.

## Get Started
Expand All @@ -50,7 +50,7 @@ HOCUS_HOSTNAME="localhost" ops/bin/local-up.sh

It will bring up:

- the Hocus control plane, a [Remix](https://github.com/remix-run/remix) application;
- The Hocus control plane, a [Remix](https://github.com/remix-run/remix) application;
- [Temporal](https://temporal.io/), which is a workflow engine;
- the Hocus agent, which is a Temporal worker;
- [Postgres](https://www.postgresql.org/);
Expand Down

0 comments on commit 4ec00d4

Please sign in to comment.