Skip to content

Commit 32f611e

Browse files
authored
Merge pull request #89 from GluuFederation/4.4
4.4
2 parents 8112fab + 835d6e8 commit 32f611e

File tree

567 files changed

+38644
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

567 files changed

+38644
-5
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/.project
2+
.idea
3+
.DS_Store

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# docs-ce-prod
1+
# docs-ce-prod
22

3-
**Each branch represents a version of CE**
4-
5-
This repo holds all versions of CE docs and includes scripts to publish. All docs are processed using mkdocs. This repo is organized with branches for each version of the documentation.
3+
This repo is holds all versions of CE docs and includes scripts to publish. All docs are processed using mkdocs. This Repo is organized with branches for each version of the documentation.
64

75
## Documentation styleguide
86

@@ -13,7 +11,8 @@ Fork, clone, and make a pull request.
1311

1412
**Note: "Master" is the branch for editing this `README.md`. You will not see documentation files until you check out the specific branch.**
1513

16-
## Check out the docs
14+
15+
## Check out specific branch
1716

1817
`$ git checkout <branchname>`
1918

docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
.idea
2+
/site

docs/LICENSE

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Copyright © 2019 Gluu, Inc. All rights reserved.
2+
3+
Unless otherwise indicated, all materials on these pages are copyrighted by Gluu, Inc.
4+
All rights reserved. No part of these pages, either text or image may be used for any
5+
purpose other than personal use. Therefore, reproduction, modification, storage in a
6+
retrieval system or retransmission, in any form or by any means, electronic, mechanical
7+
or otherwise, for reasons other than personal use, is strictly prohibited without prior
8+
written permission.
9+
10+
General inquiries should be directed to our Web contact us form, accessible from
11+
https://gluu.org/contact, or from the footer at the bottom of most pages on our
12+
website: https://gluu.org.

docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# docs-4.4 docs site
2+
Gluu Server 4.4 Docs
3+

docs/index.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to Gluu Docs
2+
3+
For full documentation visit [mkdocs.org](http://mkdocs.org).
4+
5+
## Commands
6+
7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs help` - Print this help message.
11+
12+
## Project layout
13+
14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

docs/mkdocs.yml

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
# Project information
2+
site_name: Gluu Server 4.4 Docs
3+
site_description: Documentation for Gluu Server
4+
5+
# Copyright
6+
copyright: Copyright &copy; 2021, Gluu, Inc.
7+
8+
# Repository
9+
docs_dir: source
10+
repo_name: GluuFederation/docs-gluu-server-prod
11+
repo_url: https://github.com/GluuFederation/docs-gluu-server-prod/
12+
edit_uri: edit/4.4/docs/source
13+
14+
# Configuration
15+
theme:
16+
name: material
17+
custom_dir: 'theme'
18+
palette:
19+
primary: 'green'
20+
accent: 'green'
21+
logo: 'gluu.jpg'
22+
favicon: 'favicon.ico'
23+
extra:
24+
version: '4.4'
25+
extra_css:
26+
- css/tabs.css
27+
28+
# Tracking
29+
google_analytics:
30+
- 'UA-31008645-7'
31+
- 'auto'
32+
33+
# Extensions
34+
markdown_extensions:
35+
- admonition
36+
- attr_list
37+
- toc:
38+
permalink: '#'
39+
- codehilite
40+
- pymdownx.superfences
41+
- pymdownx.tabbed
42+
43+
# Navigation
44+
nav:
45+
- 'Versions':
46+
- '4.4': 'https://gluu.org/docs/gluu-server/4.4/'
47+
- '4.3': 'https://gluu.org/docs/gluu-server/4.3/'
48+
# - '5.0': 'https://gluu.org/docs/gluu-server/5.0/'
49+
- '4.2': 'https://gluu.org/docs/gluu-server/4.2/'
50+
- '4.1': 'https://gluu.org/docs/gluu-server/4.1/'
51+
- '4.0': 'https://gluu.org/docs/gluu-server/4.0/'
52+
- 'EOL Versions': 'https://gluu.org/docs/eol/'
53+
- ' ': 'https://gluu.org/docs'
54+
- ' ': 'https://gluu.org/docs'
55+
- Home: 'index.md'
56+
- Release Notes: 'release-notes/index.md'
57+
- Whats new in v4: '4.x-intro.md'
58+
- Installation Guide:
59+
- 'VM Preparation': 'installation-guide/index.md'
60+
- 'Installation':
61+
# - 'Start here': 'installation-guide/install.md'
62+
# - 'Test Drive': 'installation-guide/test-drive.md'
63+
- 'Kubernetes': 'installation-guide/install-kubernetes.md'
64+
- 'Docker': 'installation-guide/install-docker.md'
65+
- 'Ubuntu': 'installation-guide/install-ubuntu.md'
66+
- 'RHEL': 'installation-guide/install-rhel.md'
67+
- 'CentOS': 'installation-guide/install-centos.md'
68+
- 'SUSE': 'installation-guide/install-suse.md'
69+
- 'Setup Script Options': 'installation-guide/setup_py.md'
70+
- 'Upgrade to 4.4': 'upgrade/index.md'
71+
- 'Clustering': 'installation-guide/cluster.md'
72+
- Administration Guide:
73+
- 'oxTrust admin UI': 'admin-guide/oxtrust-ui.md'
74+
- 'Interception Scripts': 'admin-guide/custom-script.md'
75+
- User Management:
76+
- 'Local User Management': 'user-management/local-user-management.md'
77+
- 'AD/LDAP Synchronization': 'user-management/ldap-sync.md'
78+
- 'IDM Synchronization': 'user-management/idm-sync.md'
79+
- 'User Registration': 'user-management/user-registration.md'
80+
- 'Collecting Metrics': 'user-management/metrics.md'
81+
- 'SCIM 2.0 User Management': 'user-management/scim2.md'
82+
- 'SCIM custom scripts': 'user-management/scim-scripting.md'
83+
- User Authentication:
84+
- 'Introduction': 'authn-guide/intro.md'
85+
- 'Basic Authentication': 'authn-guide/basic.md'
86+
- 'FIDO 2.0': 'authn-guide/fido2.md'
87+
- 'Passwordless Authn': 'authn-guide/passwordless.md'
88+
- 'Super Gluu': 'authn-guide/supergluu.md'
89+
- 'OTP apps': 'authn-guide/otp.md'
90+
- 'SMS OTP (Twilio)': 'authn-guide/sms-otp.md'
91+
- 'SMS OTP (SMPP)': 'authn-guide/sms-otp-smpp.md'
92+
- 'PingID': 'authn-guide/pingid.md'
93+
- 'Duo Security': 'authn-guide/duo.md'
94+
- 'ThumbSignIn': 'authn-guide/thumbsignin.md'
95+
- 'FIDO U2F': 'authn-guide/U2F.md'
96+
- 'Certificate Authentication': 'authn-guide/cert-auth.md'
97+
- 'Account Lockout': 'authn-guide/lockout.md'
98+
- 'Forgot Password': 'authn-guide/pw-reset.md'
99+
- 'Custom Script Tutorial': 'authn-guide/customauthn.md'
100+
- Inbound Identity:
101+
- 'Introduction': 'authn-guide/passport.md'
102+
- 'Inbound OAuth & OpenID Connect': 'authn-guide/inbound-oauth-passport.md'
103+
- 'Inbound SAML': 'authn-guide/inbound-saml-passport.md'
104+
- 'RADIUS':
105+
- 'Gluu Radius': 'admin-guide/radius-server/gluu-radius.md'
106+
- 'Radiator Plugin': 'admin-guide/radius-server/gluu-radiator.md'
107+
- 'CIBA':
108+
- 'OpenID Connect CIBA': 'admin-guide/ciba.md'
109+
- 'FAPI-CIBA': 'admin-guide/fapi-ciba.md'
110+
- 'Attributes': 'admin-guide/attribute.md'
111+
- 'SAML IDP': 'admin-guide/saml.md'
112+
- 'OpenID Connect Provider (OP)': 'admin-guide/openid-connect.md'
113+
- 'UMA Authorization Server (AS)': 'admin-guide/uma.md'
114+
- 'Central Authentication Service (CAS)': 'admin-guide/cas.md'
115+
- 'OAuth2.0 Device Authorization Grant': admin-guide/device-authz-grant/
116+
- 'Session Management': 'admin-guide/session.md'
117+
- 'Certificate Management': 'admin-guide/certificate.md'
118+
- 'CORS Configuration': 'admin-guide/cors.md'
119+
- Integration Guide:
120+
- 'Introduction': 'integration/index.md'
121+
- 'Server Side Web Apps':
122+
- 'OAuth2 Grants': 'admin-guide/oauth2.md'
123+
- 'oxd OAuth 2.0': 'integration/oxd-oauth2/index.md'
124+
- 'Nginx lua-resty-openidc': 'integration/sswebapps/nginx.md'
125+
- 'Apache mod_auth_openidc': 'integration/sswebapps/openidc-rp.md'
126+
- 'Shibboleth SAML SP': 'integration/sswebapps/saml-sp.md'
127+
- 'Single Page Apps':
128+
- 'AppAuth JS': 'integration/spa/appauth-js.md'
129+
- 'Gluu OIDC JS Client': 'integration/spa/oauth-js-implicit.md'
130+
- 'Native Apps':
131+
- 'AppAuth iOS and macOS': 'integration/native-apps/appauth-ios.md'
132+
- 'AppAuth Android': 'integration/native-apps/appauth-android.md'
133+
- 'SaaS / Off-the-shelf Apps':
134+
- 'Google Apps': 'integration/saas/google.md'
135+
- 'Office 365': 'integration/saas/office.md'
136+
- 'Moodle': 'integration/saas/moodle.md'
137+
- 'Salesforce': 'integration/saas/salesforce.md'
138+
- 'Dropbox': 'integration/saas/dropbox.md'
139+
- 'GitHub Enterprise': 'integration/saas/github-enterprise.md'
140+
- 'Cisco WebEx': 'integration/saas/webex.md'
141+
- 'Amazon Web Services (AWS)': 'integration/saas/aws.md'
142+
- 'Rocketchat': 'integration/saas/rocketchat.md'
143+
- 'SAMLtest.id': 'integration/saas/saml_test_id.md'
144+
- 'ThousandEyes': 'integration/saas/thousandeyes.md'
145+
- Reference:
146+
- Gluu API Guide:
147+
- 'Gluu Server API': 'api-guide/api.md'
148+
- 'oxTrust API': 'api-guide/oxtrust-api.md'
149+
- 'OpenID Connect API': 'api-guide/openid-connect-api.md'
150+
- 'SCIM API': 'api-guide/scim-api.md'
151+
- 'UMA API': 'api-guide/uma-api.md'
152+
- 'JSON Properties':
153+
- 'oxTrust JSON Properties': 'reference/JSON-oxtrust-prop.md'
154+
- 'oxAuth JSON Properties': 'reference/JSON-oxauth-prop.md'
155+
- 'Cache Provider Configuration': 'reference/cache-provider-prop.md'
156+
- 'Persistence Strategies':
157+
- 'Persistence Mechanisms': 'reference/persistence.md'
158+
- 'oxLDAP Properties': 'reference/oxldap.md'
159+
- 'LDAP Schema': 'reference/schema.md'
160+
- 'Kubernetes and Containers Technical Reference':
161+
- 'Config and Secret Keys': 'reference/container-configs.md'
162+
- 'Image References': 'reference/container-image-refs.md'
163+
- Operation Guide:
164+
- 'Service Commands': 'operation/services.md'
165+
# - 'Patches': 'upgrade/patches.md'
166+
- 'Backups': 'operation/backup.md'
167+
- 'CE to CN Migration': 'operation/ce_to_cn_migration.md'
168+
- 'Security tips': 'operation/security.md'
169+
- 'Performance tuning': 'operation/fine-tuning.md'
170+
- 'Ports': 'operation/ports.md'
171+
- 'Logout': 'operation/logout.md'
172+
- 'Log Management' : 'operation/logs.md'
173+
- 'Customize Public Pages': 'operation/custom-design.md'
174+
- 'Change IP Address': 'operation/changeip.md'
175+
- 'Server Clean-up': 'operation/cleanup.md'
176+
- 'Replacing Expired JKS Files': 'operation/replace-expired-jks-scim.md'
177+
- 'Auto-enrolled users clean-up': 'operation/auto-enrolled-users-clean.md'
178+
- Developer Guide:
179+
# - 'Build oxTrust with Eclipse': 'developer-guide/oxtrust-eclipse.md'
180+
- 'Coding custom scripts and pages': 'developer-guide/tips-cust-script-pages.md'
181+
- 'Localization': 'developer-guide/localization.md'
182+
- 'Script Debugging': 'developer-guide/script-debugging.md'
183+
- Tutorials:
184+
# - 'The billion load test': 'tutorials/load-test.md' # hide test until officially tested
185+
- 'A 2k Benchmark': 'tutorials/2k-benchmark.md'
186+
- 'Impossible Travel with Deduce': 'tutorials/impossible-travel.md'
187+
- 'Install Gluu CN with ALB controller': 'tutorials/cn-aws-alb.md'
188+
- 'Install Gluu CN with Rancher or RKE': 'tutorials/install-rancher.md'
189+
- 'Attributes mapping and transformation in Passport': 'tutorials/passport-attributes-mapping.md'
190+
- 'Inbound Identity with Apple Sign In': 'tutorials/passport-apple.md'
191+
- 'Inbound SAML with Passport': 'tutorials/passport-inbound-flow.md'
192+
- 'Inbound openid-client with Passport': 'tutorials/passport-openid-client.md'
193+
- 'Forgot PW': 'tutorials/forgot-pw.md'
194+
- 'Kafka Logging': 'tutorials/kafka.md'
195+
- FAQ & Troubleshooting: 'operation/faq.md'

0 commit comments

Comments
 (0)