/
mkdocs.yml
191 lines (183 loc) · 5.8 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# Copyright (c) 2011-2024 Mathias WOLFF <mathias@celea.org>
# Project information
site_name: P-KISS-SBC
site_description: >-
Simple, high performance, robust and reliable SIP Border Controller (SBC)
site_url: https://www.pyfreebilling.com/
site_author: Mathias WOLFF
# Repository
repo_name: mwolff44/pyfreebilling
repo_url: https://github.com/mwolff44/pyfreebilling
edit_uri: ''
# Copyright
copyright: >
Copyright © 2011 - 2024 Mathias WOLFF --
<a href="#__consent">Change cookie settings</a>
# Configuration
theme:
name: material
custom_dir: docs/theme_overrides
features:
- navigation.footer
- navigation.instant
- navigation.instant.progress
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- toc.follow
- search.highlight
- search.share
- search.suggest
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
toggle:
icon: material/weather-sunny
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
toggle:
icon: material/weather-night
name: Switch to light mode
font:
text: Open Sans
code: Open Sans Mono
icon:
repo: fontawesome/brands/git-alt
language: en
extra:
alternate:
- name: English
link: /en/
lang: en
- name: French
link: /fr/
lang: fr
social:
- icon: fontawesome/brands/github
link: https://github.com/mwolff44
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/in/mathias-wolff-47a7941/
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/mwolff44w/
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
# Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- pymdownx.betterem:
smart_enable: all
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.smartsymbols
- pymdownx.superfences
- toc:
permalink: true
# Plugins
plugins:
- search
- minify:
minify_html: true
#- privacy
- social
- i18n:
docs_structure: suffix
default_language: en
default_language_only: false
docs_structure: suffix
languages:
en: '<img style="height: 10px; border: 0px;" alt="en" class="twemoji" src="https://twemoji.maxcdn.com/v/latest/svg/1f1ec-1f1e7.svg" title="english" /> English'
fr: '<img style="height: 10px; border: 0px;" alt="fr" class="twemoji" src="https://twemoji.maxcdn.com/v/latest/svg/1f1eb-1f1f7.svg" title="français" /> Français'
nav_translations:
fr:
Welcome: Bienvenue
Philosophy: Philosophie
Differences between PyFreeBilling and PKS: Différences entre PyFreeBilling et PKS
Does PKS perform LCR: Est-ce que PKS fait du LCR
Use Cases: Cas d'Utilisation
Getting Started: Démarrage rapide
User Guide: Guide Utilisateur
How To: Comment Faire
How to Upgrade: Comment Mettre à Jour
Backup and Recovery: Sauvegarde et Restauration
Troubleshooting: Résolution de Problèmes
Requirements: Prérequis
Best Practices: Bonnes Pratiques
Contributing: Contribuer
Release Notes: Notes de Mise à Jour
Manage: Administrer
- git-revision-date-localized:
enable_creation_date: false
fallback_to_build_date: true
type: iso_date
- git-authors
- rss:
match_path: .*
date_from_meta:
as_creation: date
categories:
- categories
- tags
# Page tree
nav:
- Home:
- Introduction: index.md
- Philosophy: philosophy.md
- Best Practices: bestpractices.md
- FAQs:
- Index: faq/index.md
- Differences between PyFreeBilling and PKS: faq/pyfreebilling-pks-differences.md
- Does PKS perform LCR: faq/lcr-routing.md
- License: license.md
- Use Cases:
- Introduction: use-cases/usecases.md
- Securing VoIP system: use-cases/securing-telephony-system.md
- Failover: use-cases/failover.md
- High Availability: use-cases/ipbx-high-availability.md
- Geo routing: use-cases/geographical-distribution-ipbx.md
- Connect Multitenant IPBX: use-cases/connecting-mutitenant-ipbx-to-carrier.md
- Multiple Carriers: use-cases/connecting-ipbx-to-multiple-carriers.md
- Getting Started:
- getting-started.md
- Requirements: user-guide/requirements.md
- Installation: user-guide/installation.md
- Post Install: user-guide/configuration.md
- Manage: user-guide/manage.md
- How To:
- Backup and Recovery: how-to/backup-recovery.md
- How to Upgrade: how-to/upgrade.md
- Troubleshooting: how-to/troubleshooting.md
- Contributing:
- contributing/index.md
- Reporting a bug: contributing/reporting-a-bug.md
- Reporting a docs issue: contributing/reporting-a-docs-issue.md
- Requesting a change: contributing/requesting-a-change.md
- Asking a question: https://github.com/mwolff44/pyfreebilling/discussions
- Release Notes: changelog/index.md