Skip to content

Commit 4a32791

Browse files
committed
update docs
1 parent e7bdc48 commit 4a32791

29 files changed

+1362
-495
lines changed

docs/.vitepress/config.mts

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { defineConfig } from 'vitepress'
44
export default defineConfig({
55
title: "LoggiFly",
66
description: "LoggiFly Documentation",
7-
head: [['link', { rel: 'icon', href: '/loggifly/icon.png' }]],
7+
head: [['link', { rel: 'icon', href: '/LoggiFly/favicon.ico' }]],
88
base: '/LoggiFly/',
99
cleanUrls: true,
1010
themeConfig: {
@@ -23,7 +23,7 @@ export default defineConfig({
2323
text: 'Introduction',
2424
items: [
2525
{ text: 'What is LoggiFly', link: '/guide/what-is-loggifly' },
26-
{ text: 'Getting Started', link: '/guide/getting-started' }
26+
{ text: 'Getting Started', link: '/guide/getting-started' },
2727
]
2828
},
2929
{
@@ -53,18 +53,19 @@ export default defineConfig({
5353
]
5454
},
5555
{
56-
text: 'Advanced Features',
56+
text: 'Advanced',
5757
items: [
5858
{ text: 'Customize Notifications',
5959
collapsed: true,
6060
items: [
61-
{ text: 'Overview', link: '/guide/customize-notifications/' },
62-
{ text: 'JSON Logs', link: '/guide/customize-notifications/json_template' },
63-
{ text: 'Plain Text Logs', link: '/guide/customize-notifications/template' },
61+
{ text: 'Available Fields', link: '/guide/customize-notifications/' },
62+
{ text: 'Extract from JSON', link: '/guide/customize-notifications/json' },
63+
{ text: 'Extract from Regex', link: '/guide/customize-notifications/regex' },
6464
]
6565
},
6666
{ text: 'Actions', link: '/guide/actions' },
6767
{ text: 'Remote Hosts', link: '/guide/remote-hosts' },
68+
{ text: 'Healthcheck', link: '/guide/healthcheck' },
6869
]
6970
},
7071
{

docs/.vitepress/theme/custom.css

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@
3131
--vp-code-line-number-color: rgba(235, 235, 245, 0.38);
3232
}
3333

34-
table {
34+
/* table {
3535
width: 140%;
36-
}
36+
} */
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
services:
2+
loggifly:
3+
image: ghcr.io/clemcer/loggifly:latest
4+
container_name: loggifly
5+
# It is recommended to set the user so that the container does not run as root
6+
user: 1000:1000
7+
read_only: true
8+
volumes:
9+
- socket-proxy:/var/run
10+
# Place your config.yaml here if you are using one
11+
- ./config:/config
12+
depends_on:
13+
- socket-proxy
14+
restart: unless-stopped
15+
16+
socket-proxy:
17+
image: "11notes/socket-proxy:2"
18+
read_only: true
19+
# Make sure to use the same UID/GID as the owner of your docker socket.
20+
# You can check with: `ls -n /var/run/docker.sock`
21+
user: "0:996"
22+
volumes:
23+
- "/run/docker.sock:/run/docker.sock:ro"
24+
- "socket-proxy:/run/proxy"
25+
restart: "always"
26+
27+
volumes:
28+
socket-proxy:
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
services:
2+
loggifly:
3+
image: ghcr.io/clemcer/loggifly:latest
4+
container_name: loggifly
5+
read_only: true
6+
environment:
7+
ENABLE_HEALTHCHECK: true
8+
TZ: Europe/Berlin
9+
volumes:
10+
- /var/run/docker.sock:/var/run/docker.sock:ro
11+
- ./config:/config # Place your config.yaml file in this directory
12+
healthcheck:
13+
test: ["CMD", "python", "/app/healthcheck.py"]
14+
interval: 60s
15+
timeout: 5s
16+
retries: 3
17+
start_period: 30s
18+
restart: unless-stopped
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
services:
2+
loggifly:
3+
image: ghcr.io/clemcer/loggifly:latest
4+
container_name: loggifly
5+
# It is recommended to set the user so that the container does not run as root
6+
user: 1000:1000
7+
read_only: true
8+
volumes:
9+
# Place your config.yaml here if you are using one
10+
- ./config:/config
11+
environment:
12+
TZ: Europe/Berlin
13+
DOCKER_HOST: tcp://socket-proxy:2375
14+
depends_on:
15+
- socket-proxy
16+
restart: unless-stopped
17+
18+
socket-proxy:
19+
image: tecnativa/docker-socket-proxy
20+
container_name: docker-socket-proxy
21+
environment:
22+
- CONTAINERS=1
23+
- POST=0
24+
volumes:
25+
- /var/run/docker.sock:/var/run/docker.sock:ro
26+
restart: unless-stopped

docs/compose/compose.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
services:
2+
loggifly:
3+
image: ghcr.io/clemcer/loggifly:latest
4+
container_name: loggifly
5+
read_only: true
6+
environment:
7+
# Configure Environment Variables here if you don't want to use a config.yaml file
8+
TZ: Europe/Berlin
9+
volumes:
10+
- /var/run/docker.sock:/var/run/docker.sock:ro
11+
- ./config:/config # Place your config.yaml file in this directory
12+
restart: unless-stopped

0 commit comments

Comments
 (0)