Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
6946bc2
chore(docs): restructure docs directory for chronicle migration
rsbh Mar 11, 2026
8ca20a0
chore(docs): add chronicle config, delete apis, rename md to mdx
rsbh Mar 11, 2026
7cc66c0
chore(docs): convert Docusaurus components to Chronicle compatible sy…
rsbh Mar 11, 2026
fc18816
chore(docs): clean frontmatter, add ordering, escape curly braces
rsbh Mar 11, 2026
94cf5b4
fix(docs): convert missed @theme imports in metaschemas.mdx
rsbh Mar 11, 2026
40f00a6
chore(docs): restore nested docs structure, add package.json for chro…
rsbh Mar 12, 2026
65583f2
chore(docs): setup chronicle with npm scripts and init workflow
rsbh Mar 13, 2026
c2296f8
chore(docs): move chronicle.yaml to docs root
rsbh Mar 13, 2026
e598ba9
chore(docs): rename introduction.mdx to index.mdx for root route
rsbh Mar 13, 2026
86fa443
chore(docs): add chronicle config and package.json
rsbh Mar 13, 2026
7df02cb
chore(docs): remove pnpm-lock.yaml and add to gitignore
rsbh Mar 13, 2026
9b2726f
chore(docs): track package-lock.json for reproducible installs
rsbh Mar 13, 2026
bc145f0
fix(docs): add buildCommand to vercel.json for chronicle setup
rsbh Mar 13, 2026
2972158
fix(docs): update vercel.json with install, build, and framework sett…
rsbh Mar 13, 2026
0b22312
fix(docs): update chronicle version and add node 22 to vercel config
rsbh Mar 13, 2026
47ba7e9
fix(docs): move node version to package.json engines field
rsbh Mar 13, 2026
d3efe74
chore(docs): update chronicle version and remove github navbar link
rsbh Mar 13, 2026
d55004e
chore(docs): upgrade chronicle to 0.2.0
rsbh Mar 16, 2026
67d367c
chore(docs): simplify vercel config and remove package files
rsbh Mar 17, 2026
33d4ca7
chore: add docs/dist to gitignore
rsbh Mar 17, 2026
13bba66
chore(docs): add --content flag to chronicle build command
rsbh Mar 17, 2026
6865b7b
chore(docs): update chronicle to 0.1.0-canary.111b55a
rsbh Mar 17, 2026
f5b61b8
chore(docs): remove docs/.gitignore and support.mdx
rsbh Mar 17, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,4 @@ node_modules/
.claude
claude.md
.cursor
docs/dist/
20 changes: 0 additions & 20 deletions docs/.gitignore

This file was deleted.

47 changes: 0 additions & 47 deletions docs/README.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/babel.config.js

This file was deleted.

21 changes: 21 additions & 0 deletions docs/chronicle.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
title: Frontier
description: Identity and authorization for your APIs

theme:
name: default


search:
enabled: true
placeholder: Search documentation...

# api:
# - name: Frontier Administration API
# spec: apidocs.swagger.yaml
# basePath: /apis

footer:
copyright: "Open DataOps Foundation"
links:
- label: GitHub
href: https://github.com/raystack/frontier
5 changes: 5 additions & 0 deletions docs/docs/admin-portal.md → docs/docs/admin-portal.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: Admin Portal
order: 13
---

# Admin Portal

The Admin Portal provides the Frontier administrators with a centralized interface for managing the Raystack/Frontier platform. This README will guide you through the installation, setup, and usage of the Admin Portal.
Expand Down
51 changes: 32 additions & 19 deletions docs/docs/admin-settings.md → docs/docs/admin-settings.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
---
title: Platform Preferences
order: 14
---

# Platform Preferences

Expand All @@ -15,8 +17,12 @@ For example, the **disable_orgs_on_create** setting is defined in the default tr

### Create and Update Preferences

<Tabs groupId="cli">
<TabItem value="API" label="API">
<Tabs defaultValue="API">
<Tabs.List>
<Tabs.Trigger value="API">API</Tabs.Trigger>
<Tabs.Trigger value="CLI">CLI</Tabs.Trigger>
</Tabs.List>
<Tabs.Content value="API">

Use this [Create Platform Preference API](https://raystack-frontier.vercel.app/apis/admin-service-create-preferences) to create platform wide preferences.

Expand All @@ -35,8 +41,8 @@ $ curl -L -X POST 'http://127.0.0.1:7400/v1beta1/preferences' \
}'
```

</TabItem>
<TabItem value="CLI" label="CLI" default>
</Tabs.Content>
<Tabs.Content value="CLI">

```bash
## Syntax
Expand All @@ -47,7 +53,7 @@ $ frontier preferences set --name <name> --value <value>
$ frontier preferences set -n disable_orgs_on_create -v true -H X-Frontier-Email:user@raystack.org
```

</TabItem>
</Tabs.Content>
</Tabs>

Note: The setting name is case sensitive.
Expand All @@ -56,32 +62,39 @@ Note: The setting name is case sensitive.

Once the preferences are set, they can be listed using the following command:

<Tabs groupId="cli">
<TabItem value="API" label="API">
<Tabs defaultValue="API">
<Tabs.List>
<Tabs.Trigger value="API">API</Tabs.Trigger>
<Tabs.Trigger value="CLI">CLI</Tabs.Trigger>
</Tabs.List>
<Tabs.Content value="API">

```bash
$ curl -L -X GET 'http://127.0.0.1:7400/v1beta1/preferences' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dGVzdFVzZXJuYW1lOnRlc3RQYXNzd29yZA=='
```

</TabItem>

<TabItem value="CLI" label="CLI" default>
</Tabs.Content>
<Tabs.Content value="CLI">

```bash
$ frontier preferences list
```

</TabItem>
</Tabs.Content>
</Tabs>

### Describe Preferences

The Preference traits are defined in the Frontier backend to be used by the platform. Only these traits can be used to set the platform wide preferences. The platform admin can view the default traits defined in Frontier using the following command:

<Tabs groupId="cli">
<TabItem value="API" label="API">
<Tabs defaultValue="API">
<Tabs.List>
<Tabs.Trigger value="API">API</Tabs.Trigger>
<Tabs.Trigger value="CLI">CLI</Tabs.Trigger>
</Tabs.List>
<Tabs.Content value="API">

Use this [API](https://raystack-frontier.vercel.app/apis/frontier-service-describe-preferences) to list the default traits defined in Frontier, the traits with `app/platform` namespace denotes the platform wide traits.

Expand All @@ -91,14 +104,14 @@ $ curl -L -X GET 'http://127.0.0.1:7400/v1beta1/preferences/traits' \
-H 'Authorization: Basic dGVzdFVzZXI6dGVzdFBhc3M='
```

</TabItem>
<TabItem value="CLI" label="CLI" default>
</Tabs.Content>
<Tabs.Content value="CLI">

```bash
$ frontier preferences get
```

</TabItem>
</Tabs.Content>
</Tabs>

This command will list all the default traits defined in Frontier. The traits with `app/platform` namespace denotes the platform wide traits. Similarly, the traits with `app/user`, `app/organization` and `app/group` namespace denotes the user, organization and group wide traits respectively.
Expand All @@ -117,4 +130,4 @@ All the trait description, default value and usage can be found with the above c
| invite_with_roles | app/platform | Allow inviting new members with set of role ids. When the invitation is accepted, the user will be added to the org with the roles specified. | "**true**,false" |
| invite_mail_template_subject | app/platform | The subject of the invite mail sent to new members | |
| invite_mail_template_body | app/platform | The body of the invite mail sent to new members | |
---
---
395 changes: 0 additions & 395 deletions docs/docs/apis/admin-service-add-platform-user.api.mdx

This file was deleted.

Loading