Skip to content

Commit

Permalink
Merge pull request #179 from ritza-co/update-genericmigration
Browse files Browse the repository at this point in the history
Update Generic migration
  • Loading branch information
rideam authored Apr 9, 2024
2 parents 936adf0 + af36427 commit 607aec3
Show file tree
Hide file tree
Showing 120 changed files with 1,836 additions and 585 deletions.
4 changes: 2 additions & 2 deletions .github/scripts/count-repos.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ fi
#fusionauth-containers, fusionauth-theme-helper, etc
EXTRA_IN_JSON_NOT_NAMED_CORRECTLY=4

# fusionauth-example-template and (temporarily) fusionauth-example-vue-sdk
EXTRA_IN_GH_NOT_DISPLAYABLE=2
# fusionauth-example-template and (temporarily) fusionauth-example-vue-sdk, fusionauth-quickstart-java-android-fusionauth-sdk
EXTRA_IN_GH_NOT_DISPLAYABLE=3

cat astro/src/content/json/exampleapps.json|jq '.[]|.url' |sed 's/"//g'|sed 's!https://github.com/!!i' > json.list
COUNT_IN_JSON=`wc -l json.list |sed 's/^ *//' |sed 's/ .*//'`
Expand Down
5 changes: 3 additions & 2 deletions .github/vale/styles/config/vocabularies/FusionAuth/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ esport
failover
Fastly
FIDO
FusionAuth
fusionauth
[Ff]usion[Aa]uth
gameplay
Guice
HAProxy
Expand All @@ -49,6 +48,7 @@ interoperate
Inversoft
ISP
Istio
jinja
JMeter
JWT
Kaspersky
Expand Down Expand Up @@ -121,3 +121,4 @@ xkcd
Yubico
YubiKey
Zendesk
Ctrl
4 changes: 2 additions & 2 deletions DocsDevREADME.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ You can find help for {props.topic} at [help](/help)
- you may need to coerce a prop into a boolean to use as a conditional for an expression. Such as `{!!props.message && <span>{props.message}</span>}`;
- JSON files are their own content collection in astro. You can reference these using the [JSON component](astro/src/components/JSON.astro)
- We have an alias mapped in [tsconfig](astro/tsconfig.json) that allows you to use absolute references from 'src'. Otherwise, imports must use relative paths.
- If a doc pulls code from an example application, use the [RemoteContent](astro/src/components/RemoteContent.astro). You can also pull sections with tags: `<RemoteContent url="https://raw.githubusercontent.com/FusionAuth/fusionauth-react-sdk/main/README.md" tags="forDocSite" />`
- If a doc pulls code from an example application, use the [RemoteContent](astro/src/components/RemoteContent.astro). You can also pull sections with tags: `<RemoteContent url="https://raw.githubusercontent.com/FusionAuth/fusionauth-javascript-sdk/main/packages/sdk-react/README.md" tags="forDocSite" />`

### For API docs
- We have many APIs which return the same objects either singly (if called with an Id) or in an array (if called without an Id). If you are creating or modifying an API with this, see if you can use the -base pattern that the tenants and applications do to reduce duplicates.
Expand All @@ -133,7 +133,7 @@ You can find help for {props.topic} at [help](/help)
```
This field is required when <InlineField>theOtherField.enabled</InlineField> is set to true.
```
- If a feature is only available when using a paid plan, use the [PremiumEditionBlurbApi](astro/src/content/docs/_shared/_premium-edition-blurb-api.astro) component `<PremiumEditionBlurbApi premium_feature="custom forms" />` fragment for API fields, and [PremiumEditionBlurb](astro/src/content/docs/_shared/_premium-edition-blurb.astro) component for any other location where the feature is mentioned in docs. Only mark the request API fields.
- If a feature is only available when using a paid plan, use the [PremiumEditionBlurbApi](astro/src/content/docs/_shared/_premium-edition-blurb-api.astro) component `<PremiumEditionBlurbApi feature="custom forms" />` fragment for API fields, and [PremiumEditionBlurb](astro/src/content/docs/_shared/_premium-edition-blurb.astro) component for any other location where the feature is mentioned in docs. Only mark the request API fields.
- If a feature is only available when using essentials, use the [AdvancedEditionBlurbApi](astro/src/content/docs/_shared/_advanced-edition-blurb-api.astro) component for API fields, and [AdvancedEditionBlurb](astro/src/content/docs/_shared/_advanced-edition-blurb.astro) for any other location where the feature is mentioned in docs. Only mark the request API fields with this.
- If a feature is only available when using enterprise, use the [EnterpriseEditionBlurbApi](astro/src/content/docs/_shared/_enterprise-edition-blurb-api.astro) component for API fields, and [EnterpriseEditionBlurb](astro/src/content/docs/_shared/_enterprise-edition-blurb.astro) for any other location where the feature is mentioned in docs. Only mark the request API fields with this.
- If you are working in the `/api/identity-providers` folder there is a `README` there to help you understand the structure and layout of the documentation for the Identity Providers API.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions astro/src/components/Footer.astro
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ const { sections = [
{
"heading": "Get Started",
"items": [
{ "label": "download locally", "href": "/docs/v1/tech/installation-guide/docker" },
{ "label": "download locally", "href": "/docs/get-started/download-and-install/docker/" },
{ "label": "run in cloud", "href": "/pricing?step=plan&hosting=basic-cloud" },
{ "label": "quickstarts", "href": "/docs/quickstarts/" },
]
Expand All @@ -20,10 +20,10 @@ const { sections = [
{
"heading": "developers",
"items": [
{ "label": "SDKs", "href": "/docs/v1/tech/client-libraries/" },
{ "label": "API Docs", "href": "/docs/v1/tech/apis/" },
{ "label": "Documentation", "href": "https://fusionauth.io/docs/v1/tech/" },
{ "label": "release notes", "href": "/docs/v1/tech/release-notes" },
{ "label": "SDKs", "href": "/docs/sdks/" },
{ "label": "API Docs", "href": "/docs/apis/" },
{ "label": "Documentation", "href": "/docs/" },
{ "label": "release notes", "href": "/docs/release-notes/" },
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion astro/src/components/JSON.astro
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const parsedTitle = title ? parseInline(title) : '';
const code = JSON.stringify(json.data, null, 2);
---
{/* title is optional, do not render an empty em tag */}
{title && <em set:html={parsedTitle}/>}
{title && <p class="mb-0"><em set:html={parsedTitle}/></p>}
<div class="mb-14 prose-pre:mt-1">
<Code lang="json" {code}></Code>
</div>
6 changes: 4 additions & 2 deletions astro/src/components/api/API.astro
Original file line number Diff line number Diff line change
Expand Up @@ -93,8 +93,10 @@ const authenticationTypes = {
parts.map(part =>
<span class:list={[ part.type === 'segment' ? 'text-blue-300 font-semibold' : 'font-normal', 'break-words leading-5 tracking-normal']}>{ part.value }</span>
)
}
{ parameters && <span class="text-blue-300 break-words leading-5 tracking-normal">{ parameters }</span> }

}<!-- Note: This comment is removing white space between these two expressions to remove white space between the spans.
If any white space exists, it will render as a space on the page.
-->{ parameters && <span class="text-blue-300 break-words leading-5 tracking-normal">{ parameters }</span> }
</span>
</div>
</div>
Expand Down
20 changes: 14 additions & 6 deletions astro/src/components/docs/reference/ConfigurationOptions.astro
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Display configuration values in format:

<APIField name="database.password" type="String">
<p>
The password that FusionAuth will use to connect to the database. If you are using [Silent Mode](/docs/get-started/download-and-install/silent-mode) or [Setup Wizard](/docs/get-started/run-in-the-cloud/setup-wizard), then this password might be used when the <code>database.user</code> is automatically created for you, depending on your database server and configuration options.
The password that FusionAuth will use to connect to the database. If you are using <a href="/docs/get-started/download-and-install/silent-mode">Silent Mode</a> or <a href="/docs/get-started/run-in-the-cloud/setup-wizard">Setup Wizard</a>, then this password might be used when the <code>database.user</code> is automatically created for you, depending on your database server and configuration options.
</p>

<p>
Expand All @@ -69,7 +69,7 @@ Display configuration values in format:

<APIField name="database.root.password" type="String">
<p>
The password that FusionAuth will use to connect to the database server as part of [Silent Mode](/docs/get-started/download-and-install/silent-mode) or [Setup Wizard](/docs/get-started/run-in-the-cloud/setup-wizard) if it cannot connect using the <code>database.username</code> and <code>database.password</code> values. This should be the password for a user that has superuser privileges to the database. For example, many PostgreSQL servers will provide you with a password for the <code>postgres</code> user. Similarly, MySQL servers sometimes leave the password blank for the <code>mysql</code> user.
The password that FusionAuth will use to connect to the database server as part of <a href="/docs/get-started/download-and-install/silent-mode">Silent Mode</a> or <a href="/docs/get-started/run-in-the-cloud/setup-wizard">Setup Wizard</a> if it cannot connect using the <code>database.username</code> and <code>database.password</code> values. This should be the password for a user that has superuser privileges to the database. For example, many PostgreSQL servers will provide you with a password for the <code>postgres</code> user. Similarly, MySQL servers sometimes leave the password blank for the <code>mysql</code> user.
</p>

<p>
Expand All @@ -79,7 +79,7 @@ Display configuration values in format:

<APIField name="database.root.username" type="String">
<p>
The password that FusionAuth will use to connect to the database server as part of [Silent Mode](/docs/get-started/download-and-install/silent-mode) or [Setup Wizard](/docs/get-started/run-in-the-cloud/setup-wizard) if it cannot connect using the <code>database.username</code> and <code>database.password</code> values. This should be the username that has superuser privileges to the database. For example, many PostgreSQL servers use the username of <code>postgres</code> for the superuser account. Similarly, MySQL servers often use the username <code>mysql</code> for the superuser account.
The password that FusionAuth will use to connect to the database server as part of <a href="/docs/get-started/download-and-install/silent-mode">Silent Mode</a> or <a href="/docs/get-started/run-in-the-cloud/setup-wizard">Setup Wizard</a> if it cannot connect using the <code>database.username</code> and <code>database.password</code> values. This should be the username that has superuser privileges to the database. For example, many PostgreSQL servers use the username of <code>postgres</code> for the superuser account. Similarly, MySQL servers often use the username <code>mysql</code> for the superuser account.
</p>

<p>
Expand Down Expand Up @@ -142,7 +142,7 @@ Display configuration values in format:

<APIField name="database.username" type="String">
<p>
The database user that FusionAuth will use to connect to the database. If you are using [Silent Mode](/docs/get-started/download-and-install/silent-mode) or [Setup Wizard](/docs/get-started/run-in-the-cloud/setup-wizard), then this user might be automatically created for you, depending on your database server and configuration options. If this user is created as part of [Silent Mode](/docs/get-started/download-and-install/silent-mode) or [Setup Wizard](/docs/get-started/run-in-the-cloud/setup-wizard), it will also be the owner of the database and schema for FusionAuth.
The database user that FusionAuth will use to connect to the database. If you are using <a href="/docs/get-started/download-and-install/silent-mode">Silent Mode</a> or <a href="/docs/get-started/run-in-the-cloud/setup-wizard">Setup Wizard</a>, then this user might be automatically created for you, depending on your database server and configuration options. If this user is created as part of <a href="/docs/get-started/download-and-install/silent-mode">Silent Mode</a> or <a href="/docs/get-started/run-in-the-cloud/setup-wizard">Setup Wizard</a>, it will also be the owner of the database and schema for FusionAuth.
</p>

<span class="text-red-700">Deprecated names:</span>
Expand Down Expand Up @@ -191,6 +191,10 @@ Display configuration values in format:
<span class="text-red-700">Deprecated in version <code>1.37.0</code>.</span>
</APIField>

<APIField name="fusionauth-app.entity-search-index.name" type="String" defaults="defaults to `fusionauth_entity`" since="1.22.0">
The name of the Elasticsearch index that will be created by FusionAuth to index entities.
</APIField>

<APIField name="fusionauth-app.http-local.port" type="Integer" defaults="Defaults to `9012`" since="1.36.0">
<p>
The port number that FusionAuth will use to make HTTP requests to itself over localhost. This is port is only used by FusionAuth itself, when making an API call, or using any browser based connections to FusionAuth, please use the port configured by <InlineField>fusionauth-app.http.port</InlineField>.
Expand Down Expand Up @@ -357,15 +361,19 @@ Display configuration values in format:
<li><code>production</code></li></ul>

<p>
When in the <code>development</code> runtime mode, maintenance mode will interactively assist you configuring the database and connecting to Elasticsearch if configured. Once you move FusionAuth into production, it is recommended that you modify the runtime mode to <code>production</code>. When in <code>production</code> runtime mode maintenance mode will no longer be available to you which means you can be certain that your end users will not find themselves on the database upgrade panel during an Upgrade. When in <code>production</code> mode you will either need to leverage [Silent Mode](/docs/get-started/download-and-install/silent-mode) to automatically apply database migrations or you will need to apply the database migrations yourself (either by hand or via a script of some sort).
When in the <code>development</code> runtime mode, maintenance mode will interactively assist you configuring the database and connecting to Elasticsearch if configured. Once you move FusionAuth into production, it is recommended that you modify the runtime mode to <code>production</code>. When in <code>production</code> runtime mode maintenance mode will no longer be available to you which means you can be certain that your end users will not find themselves on the database upgrade panel during an Upgrade. When in <code>production</code> mode you will either need to leverage <a href="/docs/get-started/download-and-install/silent-mode">Silent Mode</a> to automatically apply database migrations or you will need to apply the database migrations yourself (either by hand or via a script of some sort).
</p>

<span class="text-red-700">Deprecated names:</span>
<ul><li><code>fusionauth.runtime-mode</code></li></ul>
</APIField>

<APIField name="fusionauth-app.search.default-refresh-interval" type="String" defaults="1s" since="1.49.2">
The default search index <code>refresh_interval</code>. Bulk operations (bulk user import and reindex) may temporarily relax this value for better performance and then set it back to this value. This value specifies the delay before updated User and Entity data are available to search requests. Must be a valid <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-functions-datetime.html">Elasticsearch Date/Time Interval Value</a>, however setting this variable is not recommended.
</APIField>

<APIField name="fusionauth-app.silent-mode" type="Boolean" defaults="defaults to `true`" since="1.19.0">
Determines if FusionAuth should use [Silent Mode] during the startup process. Previous to version <code>1.19.0</code>, Silent Mode was only available when the [field](/docs/get-started/download-and-install/silent-mode)#fusionauth-app.runtime-mode# was <code>development</code>. This has been changed so that FusionAuth can now automatically apply database migrations during the startup process.
Determines if FusionAuth should use [Silent Mode] during the startup process. Previous to version <code>1.19.0</code>, Silent Mode was only available when the <a href="/docs/get-started/download-and-install/silent-mode"><InlineField>fusionauth-app.runtime-mode</InlineField></a> was <code>development</code>. This has been changed so that FusionAuth can now automatically apply database migrations during the startup process.
</APIField>

<APIField name="fusionauth-app.url" type="String" since="1.4.0">
Expand Down
42 changes: 42 additions & 0 deletions astro/src/components/quickstarts/QuickstartTshirtCTA.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<section
class="flex flex-wrap border-indigo-400 border rounded p-2 gap-2 md:p-8"
>
<div class="flex flex-col gap-8 min-w-full xl:min-w-[520px] md:flex-1">
<h2 class="text-5xl">
Made it this far? Get a <span class="text-[#15b8a6]">free</span> t-shirt, on
us!
</h2>
<p class="text-3xl not-prose">
Thank you for spending some time getting familiar with Fusion<span
class="text-[#f58320]">Auth.</span
>
</p>
<div class="flex">
<a href="https://go.fusionauth.io/tshirt" class="not-prose">
<button
class="bg-orange-500 font-bold hover:bg-orange-600 px-3 py-2
rounded text-white text-xl tracking-tighter transition-colors uppercase
lg:font-extrabold"
>Ship It!
</button>
</a>
</div>
<p class="text-md md:text-lg not-prose">
*Offer only valid in the United States and Canada, while supplies last.
</p>
</div>

<a
href="https://go.fusionauth.io/tshirt"
class="not-prose grow md:shrink-0 flex justify-center align-middle items-center"
>
<img
src="https://assets-global.website-files.com/617b1b1f42c1da41aeae3413/65d4e0aa4728e21e6d690fbb_61fc3971a32d0adbbe6ad44b_t-shirt.png"
loading="lazy"
sizes="(max-width: 479px) 94vw, (max-width: 991px) 41vw, (max-width: 1279px) 396px, 481.71875px"
alt="fusionauth tshirt"
srcset="https://assets-global.website-files.com/617b1b1f42c1da41aeae3413/65d4e0aa4728e21e6d690fbb_61fc3971a32d0adbbe6ad44b_t-shirt-p-500.png 500w, https://assets-global.website-files.com/617b1b1f42c1da41aeae3413/65d4e0aa4728e21e6d690fbb_61fc3971a32d0adbbe6ad44b_t-shirt-p-800.png 800w, https://assets-global.website-files.com/617b1b1f42c1da41aeae3413/65d4e0aa4728e21e6d690fbb_61fc3971a32d0adbbe6ad44b_t-shirt.png 918w"
class="h-full lg:h-64 w-full lg:w-64"
/>
</a>
</section>
Loading

0 comments on commit 607aec3

Please sign in to comment.