diff --git a/.vitepress/config.mts b/.vitepress/config.mts index c4a0b28..a0de94f 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -52,10 +52,10 @@ function sidebarDocs(): DefaultTheme.SidebarItem[] { ] }, { - text: "Install WebhookX", - collapsed: false, + text: "Install", + link: 'docs/install/index', items: [ - { text: 'Docker', link: 'docs/install/docker' }, + { text: 'WebhookX', link: 'docs/install/index' }, ] }, { diff --git a/docs/install/docker.md b/docs/install/docker.md deleted file mode 100644 index d4b0970..0000000 --- a/docs/install/docker.md +++ /dev/null @@ -1,80 +0,0 @@ -# Docker - - -### Prerequisites - -- Docker - - -```yaml -services: - webhookx-migration: - image: "webhookx/webhookx:0.2.0" - container_name: webhookx-migration - environment: - WEBHOOKX_DATABASE_HOST: webhookx-database - WEBHOOKX_DATABASE_USERNAME: webhookx - WEBHOOKX_DATABASE_DATABASE: webhookx - WEBHOOKX_DATABASE_PORT: 5432 - command: webhookx migrations up - depends_on: - webhookx-database: - condition: service_healthy - - webhookx: - image: "webhookx/webhookx:0.2.0" - container_name: webhookx - environment: - WEBHOOKX_DATABASE_HOST: webhookx-database - WEBHOOKX_DATABASE_USERNAME: webhookx - WEBHOOKX_DATABASE_DATABASE: webhookx - WEBHOOKX_DATABASE_PORT: 5432 - WEBHOOKX_REDIS_HOST: redis - WEBHOOKX_REDIS_PORT: 6379 - WEBHOOKX_ADMIN_LISTEN: 0.0.0.0:8080 - WEBHOOKX_WORKER_ENABLED: true - WEBHOOKX_PROXY_LISTEN: 0.0.0.0:8081 - ports: - - "8080:8080" - - "8081:8081" - depends_on: - webhookx-database: - condition: service_healthy - redis: - condition: service_started - webhookx-migration: - condition: service_started - - webhookx-database: - image: postgres:13 - environment: - POSTGRES_DB: webhookx - POSTGRES_USER: webhookx - POSTGRES_HOST_AUTH_METHOD: trust - healthcheck: - test: [ "CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}" ] - interval: 3s - timeout: 5s - retries: 3 - volumes: - - "postgres_data:/var/lib/postgresql/data/" - - redis: - image: redis:6 - command: "--appendonly yes --appendfsync everysec" - volumes: - - "redis_data:/data" - -volumes: - postgres_data: - redis_data: -``` - - -``` -$ docker compose up -``` - -``` -$ curl http://localhost:8080 -``` diff --git a/docs/install/index.md b/docs/install/index.md new file mode 100644 index 0000000..99bb7a5 --- /dev/null +++ b/docs/install/index.md @@ -0,0 +1,25 @@ +# Install WebhookX + + +## macOS + +``` +$ brew tap webhookx-io/webhookx +$ brew install webhookx +``` + + +## Linux + +- Download the binary distribution on [releases](https://github.com/webhookx-io/webhookx/releases). + +## Windows: + +- Download the binary distribution on [releases](https://github.com/webhookx-io/webhookx/releases). + +## Docker Compose + +``` +$ curl -O https://raw.githubusercontent.com/webhookx-io/webhookx/master/docker-compose.yml +$ docker compose up +```