Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
webhookx-x committed Sep 6, 2024
1 parent 3edfd7e commit bff8bd6
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 31 deletions.
31 changes: 14 additions & 17 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ export default defineConfig({

nav: [
{
text: 'Docs',
link: '/docs',
activeMatch: '/'
text: 'Documentation',
link: '/docs/index',
activeMatch: '/docs'
},
{
text: 'Blog',
Expand All @@ -25,7 +25,7 @@ export default defineConfig({
],

sidebar: {
'/': { base: '/', items: sidebarDocs() },
'/docs/': { base: '', items: sidebarDocs() },
'/blog/': { base: '/blog/', items: sidebarBlog() }
},

Expand All @@ -42,41 +42,38 @@ export default defineConfig({
function sidebarDocs(): DefaultTheme.SidebarItem[] {
return [
{
text: "Introduction",
collapsed: false,
text: "Home",
items: [
{ text: 'Overview', link: 'introduction/overview' },
{ text: 'CLI', link: 'docs/cli' },
{ text: 'Overview', link: 'docs/index' },
]
},
{
text: "Install WebhookX",
collapsed: true,
collapsed: false,
items: [
{ text: 'Docker', link: 'install/docker' },
// { text: 'Kubernetes', link: 'install/kubernetes' },
// { text: 'Linux', link: 'install/linux' },
{ text: 'Docker', link: 'docs/install/docker' },
]
},
{
text: "Deployment",
collapsed: false,
items: [
{ text: 'Configuration', link: 'configuration' },
{ text: 'Configuration', link: 'docs/configuration' },
]
},
{
text: "Admin API",
collapsed: false,
items: [
{ text: 'Overview', link: 'admin/overview' },
{ text: 'Overview', link: 'docs/admin/overview' },
]
},
{
text: "Others",
collapsed: false,
text: "References",
items: [
{ text: 'Release Notes', link: 'https://github.com/webhookx-io/webhookx/releases/' }
{ text: 'CLI', link: 'docs/cli' },
{ text: 'OpenAPI', link: 'https://github.com/webhookx-io/webhookx/blob/main/openapi.yml' },
{ text: 'Release Notes', link: 'https://github.com/webhookx-io/webhookx/releases' },
]
},
]
Expand Down
5 changes: 1 addition & 4 deletions blog/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# Posts


- Post 1
- Post 2
- Post 3
👋 Coming soon...
Empty file removed docs-index.md
Empty file.
File renamed without changes.
File renamed without changes.
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# Documentation
# Documentation

WebhookX is an open-source webhooks gateway for message receiving, processing, and delivering.

👋Coming soon...
14 changes: 11 additions & 3 deletions install/docker.md → docs/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
```yaml
services:
webhookx-migration:
image: "webhookx-io/webhookx:latest"
image: "webhookx/webhookx:latest"
container_name: webhookx-migration
environment:
WEBHOOKX_DATABASE_HOST: webhookx-database
Expand All @@ -19,7 +19,7 @@ services:
condition: service_healthy

webhookx:
image: "webhookx-io/webhookx:latest"
image: "webhookx/webhookx:latest"
container_name: webhookx
environment:
WEBHOOKX_DATABASE_HOST: webhookx-database
Expand Down Expand Up @@ -49,10 +49,18 @@ services:
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:
```
Expand All @@ -62,4 +70,4 @@ $ docker compose up

```
$ curl http://localhost:8080
```
```
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ layout: home

hero:
name: "WebhookX"
text: "An modern webhooks gateway"
text: "A modern webhooks gateway"
tagline: WebhookX is an open-source webhooks gateway for message receiving, processing, and delivering.
actions:
- theme: alt
text: Quickstart
link: /introduction/overview
link: /docs/index


#features:
Expand Down
4 changes: 0 additions & 4 deletions introduction/overview.md

This file was deleted.

0 comments on commit bff8bd6

Please sign in to comment.