Skip to content

Commit

Permalink
docs: fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr committed Aug 7, 2020
1 parent 50f0c73 commit dd3bfbe
Show file tree
Hide file tree
Showing 10 changed files with 64 additions and 29 deletions.
20 changes: 10 additions & 10 deletions docs/config.js
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
module.exports = {
projectName: 'ORY Oathkeeper',
projectSlug: 'oathkeeper',
projectTagLine: 'A cloud native Identity & Access Proxy / API (IAP) and Access Control Decision API that authenticates, authorizes, and mutates incoming HTTP(s) requests. Inspired by the BeyondCorp / Zero Trust white paper. Written in Go.',
projectTagLine:
'A cloud native Identity & Access Proxy / API (IAP) and Access Control Decision API that authenticates, authorizes, and mutates incoming HTTP(s) requests. Inspired by the BeyondCorp / Zero Trust white paper. Written in Go.',
updateTags: [
{
image: 'oryd/oathkeeper',
files: [
'docs/docs/install.md',
'docs/docs/configure-deploy.md'
]
files: ['docs/docs/install.md', 'docs/docs/configure-deploy.md']
},
{
replacer: ({content, next}) => content.replace(/v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?/gi, `${next}`),
files: [
'docs/docs/install.md',
]
replacer: ({ content, next }) =>
content.replace(
/v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?/gi,
`${next}`
),
files: ['docs/docs/install.md']
}
],
updateConfig: {
src: '.schema/config.schema.json',
dst: './docs/docs/reference/configuration.md'
}
};
}
2 changes: 1 addition & 1 deletion docs/docs/configure-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ For this guide we are using Docker. ORY Oathkeeper however can be

ORY Oathkeeper can be configured via the filesystem as well as environment
variables. For more information on mapping the keys to environment variables
please head over to the [configuration chapter](configuration.md).
please head over to the [configuration chapter](reference/configuration.md).

First, create an empty directory and `cd` into it:

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ code when upgrading versions. Therefore, we do not make backwards compatibility
promises with regards to the generated SDKs. We hope to improve this process in
the future.

Before you check out the SDKs, head over to the
[REST API](oathkeeper/sdk/api.mdx) documentation which includes code samples for
common programming languages for each REST endpoint.
Before you check out the SDKs, head over to the [REST API](../reference/api)
documentation which includes code samples for common programming languages for
each REST endpoint.

We publish our SDKs for popular languages in their respective package
repositories:
Expand Down
11 changes: 6 additions & 5 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@ const config = require('./contrib/config.js')
const fs = require('fs')
const admonitions = require('remark-admonitions')

const githubRepoName = config.projectSlug === 'ecosystem'
? 'docs'
: config.projectSlug
const githubRepoName =
config.projectSlug === 'ecosystem' ? 'docs' : config.projectSlug

const links = [
{
to: "/",
to: '/',
activeBasePath: `${config.projectSlug}/docs`,
label: `Docs`,
position: 'left'
Expand Down Expand Up @@ -80,7 +79,9 @@ module.exports = {
logo: {
alt: config.projectName,
src: `img/logo-${config.projectSlug}.svg`,
href: `https://www.ory.sh/${config.projectSlug === 'ecosystem' ? '' : config.projectSlug}`
href: `https://www.ory.sh/${
config.projectSlug === 'ecosystem' ? '' : config.projectSlug
}`
},
items: links
},
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.37/configure-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ exposing the
available rules.

For this guide we are using Docker. ORY Oathkeeper however can be
[installed in a variety of ways](install.md).
[installed in a variety of ways](install).

## Configure

ORY Oathkeeper can be configured via the filesystem as well as environment
variables. For more information on mapping the keys to environment variables
please head over to the [configuration chapter](configuration.md).
please head over to the [configuration chapter](reference/configuration).

First, create an empty directory and `cd` into it:

Expand Down
4 changes: 0 additions & 4 deletions docs/versioned_docs/version-v0.37/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,6 @@ Config files can be formatted as JSON, YAML and TOML. Some configuration values
support reloading without server restart. All configuration values can be set
using environment variables, as documented below.

To find out more about edge cases like setting string array values through
environmental variables head to the
[Configuring ORY services](../ecosystem/configuring) section.

```yaml
## ORY Oathkeeper Configuration
#
Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.37/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ promises with regards to the generated SDKs. We hope to improve this process in
the future.

Before you check out the SDKs, head over to the
[REST API](oathkeeper/sdk/api.md) documentation which includes code samples for
[REST API](../reference/api) documentation which includes code samples for
common programming languages for each REST endpoint.

We publish our SDKs for popular languages in their respective package
Expand Down
4 changes: 2 additions & 2 deletions docs/versioned_docs/version-v0.38/configure-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ exposing the
available rules.

For this guide we are using Docker. ORY Oathkeeper however can be
[installed in a variety of ways](install.md).
[installed in a variety of ways](install).

## Configure

ORY Oathkeeper can be configured via the filesystem as well as environment
variables. For more information on mapping the keys to environment variables
please head over to the [configuration chapter](configuration.md).
please head over to the [configuration chapter](reference/configuration).

First, create an empty directory and `cd` into it:

Expand Down
2 changes: 1 addition & 1 deletion docs/versioned_docs/version-v0.38/sdk/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ promises with regards to the generated SDKs. We hope to improve this process in
the future.

Before you check out the SDKs, head over to the
[REST API](oathkeeper/sdk/api.mdx) documentation which includes code samples for
[REST API](../reference/api) documentation which includes code samples for
common programming languages for each REST endpoint.

We publish our SDKs for popular languages in their respective package
Expand Down
38 changes: 38 additions & 0 deletions pipeline/context.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
package pipeline

import (
"net/http"
"net/url"
)

type Context struct {
}

type ContextRequest struct {
http.Request
Header http.Header `json:"header"`
MatchContext MatchContext `json:"match"`
Method string
}

type ContextResponse struct {
URL string `json:"url"`
Header http.Header `json:"header"`
Proto string `json:"proto"`
Host string `json:"host"`
RemoteAddr string `json:"remote_address"`

RegexpCaptureGroups []string `json:"regexp_capture_groups"`
}

type AuthenticationSession struct {
Subject string `json:"subject"`
Extra map[string]interface{} `json:"extra"`
Header http.Header `json:"header"`
MatchContext MatchContext `json:"match_context"`
}

type MatchContext struct {
RegexpCaptureGroups []string `json:"regexp_capture_groups"`
URL *url.URL `json:"url"`
}

0 comments on commit dd3bfbe

Please sign in to comment.