Skip to content

Start here doc #3449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 83 commits into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
83 commits
Select commit Hold shift + click to select a range
41f3735
added outline of 'start here' page
mooreds Dec 20, 2024
2575cc2
start to build out identity provider section
mooreds Dec 20, 2024
f37afc2
add google login
mooreds Dec 20, 2024
67f1f8e
screenshots of configuration
mooreds Dec 21, 2024
f44b5e6
built out 'add' section
mooreds Dec 21, 2024
9dbef8d
import needed component
mooreds Dec 23, 2024
6f1bc37
more screenshots
mooreds Dec 23, 2024
7131127
some image cleanup
mooreds Dec 23, 2024
040e173
added link for free trial
mooreds Dec 23, 2024
d253d4a
Adding the first run of docker instructions
synedra Dec 23, 2024
b370c19
Adding the final step to check your installation
synedra Dec 23, 2024
a7a83a6
Adding the rest of launch and delegate as well.
synedra Dec 30, 2024
78d062e
Fixing the delegation
synedra Dec 30, 2024
2d41d90
Update astro/src/content/docs/get-started/start-here/index.mdx
synedra Dec 30, 2024
c7fa9e8
Update astro/src/content/docs/get-started/start-here/index.mdx
synedra Dec 30, 2024
ba715c6
Update astro/src/content/docs/get-started/start-here/index.mdx
synedra Dec 31, 2024
f3f7f25
Changes related to PR comments from mooreds. One task still remains …
synedra Dec 31, 2024
0bde7d0
Adding the token exchange piece to the instructions
synedra Jan 2, 2025
9aa4318
wordsmithing
mooreds Jan 7, 2025
ad15bc4
added and updated screenshots
mooreds Jan 7, 2025
7450952
revisions and wordsmithing
mooreds Jan 7, 2025
7fdd258
Shrink images
mooreds Jan 7, 2025
01347ab
Changes per most recent PR comments
synedra Jan 8, 2025
4bdfcfd
Cleanup per status meeting this morning 1/8
synedra Jan 8, 2025
713fe4f
Switching coderoot to fusionauth
synedra Jan 8, 2025
ceb5191
Fixing pointer to incorrect repo
synedra Jan 10, 2025
16c55aa
Adjustments for the gitpod flow
synedra Jan 10, 2025
5e3b7c4
Adjustments for the gitpod flow
synedra Jan 10, 2025
72b2f29
pulling the screenshot in, adding back in some changes from 74509522a…
mooreds Jan 10, 2025
372417f
wordsmithing
mooreds Jan 10, 2025
9bbebcc
Update astro/src/components/get-started/DockerInstallAndStart.astro
synedra Jan 10, 2025
1c7d19a
Update astro/src/components/get-started/DockerInstallAndStart.astro
synedra Jan 10, 2025
22802da
Update astro/src/content/docs/get-started/start-here/index.mdx
synedra Jan 10, 2025
279af07
Update astro/src/components/get-started/DockerInstallAndStart.astro
synedra Jan 10, 2025
ce915c3
Update astro/src/content/docs/get-started/start-here/index.mdx
synedra Jan 10, 2025
d3a8781
More changes based on PR comments
synedra Jan 10, 2025
b9e1768
More changes based on PR comments
synedra Jan 10, 2025
73aea86
Merge branch 'main' of https://github.com/fusionauth/fusionauth-site …
synedra Jan 13, 2025
fc3dbdc
Merge branch 'main' into mooreds/get-started
mooreds Jan 13, 2025
a8e6e6c
Shrink images
mooreds Jan 13, 2025
df082be
Merge branch 'mooreds/get-started' of https://github.com/fusionauth/f…
synedra Jan 13, 2025
9e9b8ec
Fixing some bad organization in vale list
synedra Jan 13, 2025
b61beeb
Found some low hanging fruit with the vale stuff. Fixed.
synedra Jan 13, 2025
a65af59
Update astro/src/content/docs/get-started/start-here/index.mdx
mooreds Jan 13, 2025
618ce62
Update astro/src/content/docs/get-started/start-here/index.mdx
synedra Jan 13, 2025
2b51840
Fixing the accordions
synedra Jan 13, 2025
4c14ae1
Fixing the accordions
synedra Jan 13, 2025
eda0135
adjusted code blocks
mooreds Jan 14, 2025
aa7679f
Merge branch 'mooreds/get-started' of github.com:FusionAuth/fusionaut…
mooreds Jan 14, 2025
79fcd7a
Fixing a minor typo
synedra Jan 14, 2025
8714341
Merge branch 'mooreds/get-started' of https://github.com/fusionauth/f…
synedra Jan 14, 2025
0c280de
wordsmithing
mooreds Jan 15, 2025
c5668c1
wordsmithing
mooreds Jan 15, 2025
33a9eba
removing duplicative aside
mooreds Jan 15, 2025
ca2d27a
wordsmithing
mooreds Jan 15, 2025
d5acb41
Removing the accordion component for docker
synedra Jan 16, 2025
3572bd3
Fixing the URLs for GitPod
synedra Jan 16, 2025
93cec17
Adding a couple of horizontal rules
synedra Jan 16, 2025
8f16d59
final review/wordsmithing.
mooreds Jan 16, 2025
e35aa28
Shrink images
mooreds Jan 16, 2025
a1b43e3
fixing community plan casing
mooreds Jan 16, 2025
f074d39
Merge branch 'main' into mooreds/get-started
mooreds Jan 17, 2025
5a4a749
Shrink images
mooreds Jan 17, 2025
a6e2a19
wrodsmithing
mooreds Jan 17, 2025
687b953
updated image to remove 'change bank' branding
mooreds Jan 17, 2025
84d66f6
removing some stuff, wordsmithing
mooreds Jan 17, 2025
70af17b
fixed typos
mooreds Jan 17, 2025
4c5bcdd
remove colon
mooreds Jan 17, 2025
0fe06f1
more wording changes for clarification
mooreds Jan 17, 2025
332ae0c
Shrink images
mooreds Jan 17, 2025
ad312a5
fixed 'gitpod' casing
mooreds Jan 17, 2025
bd982ec
Merge branch 'mooreds/get-started' of github.com:FusionAuth/fusionaut…
mooreds Jan 17, 2025
b91122a
Add more clarity to the Start Here guide
synedra Jan 22, 2025
bfd6a95
Add more clarity to the Start Here guide
synedra Jan 22, 2025
d3c5b25
Add more clarity to the Start Here guide
synedra Jan 22, 2025
76bbb7d
A few more changes to increase clarity.
synedra Jan 22, 2025
e322cc0
Fixing a vale issue
synedra Jan 22, 2025
d64f03a
Creating a cleaner browser experience for the tutorial
synedra Jan 23, 2025
6f57dfe
Update astro/src/components/get-started/DockerInstallAndStart.astro
synedra Jan 23, 2025
3cb66a9
Update astro/src/components/get-started/GitPodStart.astro
synedra Jan 23, 2025
2d8d38e
Update astro/src/content/docs/get-started/start-here/index.mdx
synedra Jan 23, 2025
f11bf11
Update GitPodStart.astro
synedra Jan 23, 2025
3f32f75
fixing whitespace
mooreds Jan 23, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
78 changes: 78 additions & 0 deletions astro/src/components/get-started/DockerInstallAndStart.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@

---
import DockerSpinupAccordion from 'src/components/get-started/DockerSpinupAccordion.astro';
import Code from 'astro/components/Code.astro';
import Aside from 'src/components/Aside.astro';
import { RemoteValue } from '@fusionauth/astro-components';

export interface Props {
/**
* Full URI to extract values from kickstart.json
* e.g. https://raw.githubusercontent.com/FusionAuth/fusionauth-quickstart-ruby-on-rails-web/main/kickstart/kickstart.json
*/
kickstartUri: string;

/**
* Flag that indicates the codeRoot
*/
codeRoot?: boolean;

}

const { kickstartUri, codeRoot } = Astro.props as Props;
---
<dd>
<h2> Docker Requirements</h2>
<Aside type="note">
You need to have Docker and Docker Compose installed.</Aside>


<p>This document has been tested with Docker version `27.3.1`, but should work with other versions.</p>

<i>Testing the Docker Installation</i>

<Code lang="shell" code="docker -v" />

<i>Result Of Testing the Docker Installation</i>
<Code lang="shell" code="Docker version 27.3.1, build ce12230"/>

<h2> Install and Start</h2>

<h3>Clone the Code</h3>
<p>First off, grab the code from the repository and change into that directory.</p>

<Code lang="shell" code={`git clone https://github.com/FusionAuth/fusionauth-example-express-start-here/ && \\
cd fusionauth-example-express-start-here`}/>

<h3>Start FusionAuth via Docker</h3>

<p>You'll find a Docker Compose file (<code>docker-compose.yml</code>) and an environment variables configuration file (<code>.env</code>) in the root directory of the repo.</p>

<p>Stand up FusionAuth on your machine with the following command.</p>

<Code lang="shell" code="docker compose up -d" />

<p>You should see multiple containers start up; one for the database, one for FusionAuth and one for our mail server.</p>

<p>Here you are using a bootstrapping feature of FusionAuth called <a href="/docs/get-started/download-and-install/development/kickstart">Kickstart</a>. When FusionAuth comes up for the first time, it will look at the <code>kickstart/kickstart.json</code> file and configure FusionAuth to the specified state. In this case, it is adding an application and a couple of users which you'll use later in the guide.</p>

<Aside type="note">
<p>If you ever want to reset the FusionAuth application, you need to delete the volumes created by Docker Compose by executing <code style="white-space: nowrap">docker compose down -v</code>, then re-run <code>docker compose up -d</code>.</p>
</Aside>

<h3>Initial Settings</h3>
<p>FusionAuth will be initially configured with these settings:</p>

<ul>
<li>Your example username is <code><RemoteValue url={kickstartUri} selector="$.variables.userEmail" /></code> and the password is <code><RemoteValue url={kickstartUri} selector="$.variables.userPassword" /></code>.</li>
<li>Your admin username is <code><RemoteValue url={kickstartUri} selector="$.variables.adminEmail" /></code> and the password is <code><RemoteValue url={kickstartUri} selector="$.variables.adminPassword" /></code>.</li>
<li>The base URL of FusionAuth is <code>http://localhost:9011/</code>.</li>
</ul>

<h2>Summing Up</h2>

<p>To verify that your system is set up, navigate to <a href="http://localhost:9011/admin">http://localhost:9011/admin</a> and log in using the admin credentials above. You will see the FusionAuth admin UI.</p>

<p>Congratulations! You've got your own FusionAuth instance running on your system using Docker.</p>

</dd>
23 changes: 23 additions & 0 deletions astro/src/components/get-started/DockerRequirements.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
import Code from 'astro/components/Code.astro';
import Aside from 'src/components/Aside.astro';
---
<dd>
<h2> Docker Requirements</h2>
<Aside type="note">
You need to have Docker and Docker Compose installed.</Aside>


<p>This document has been tested with Docker version 20, but should work with other versions.</p>

<i>Testing the Docker Installation</i>

<Code lang="shell" code="docker -v" />


<i>Result Of Testing the Docker Installation</i>
<Code lang="shell" code="Docker version 20.10.17, build 100c701"/>

</dd>


51 changes: 51 additions & 0 deletions astro/src/components/get-started/GitPodStart.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
import Aside from 'src/components/Aside.astro';
import Code from 'astro/components/Code.astro';
import { RemoteValue } from '@fusionauth/astro-components';

export interface Props {
/**
* Full URI to extract values from kickstart.json
* e.g. https://raw.githubusercontent.com/FusionAuth/fusionauth-quickstart-ruby-on-rails-web/main/kickstart/kickstart.json
*/
kickstartUri: string;

}

const { kickstartUri, api = false } = Astro.props as Props;
---
<dd>

<Aside type="note" title="GitPod Registration"> Note that the first time you start a GitPod workspace you will need to answer some demographic questions, but after that it will run without interruption.</Aside>

<p>Click on the GitPod button below to start up your environment. It will take a few minutes to bring up the servers, so please be patient until the login page loads into the environment.</p>

<a href="https://gitpod.io/#https://github.com/fusionauth/fusionauth-example-express-start-here" target="_blank" alt="Open in GitPod"><img src="https://gitpod.io/button/open-in-gitpod.svg" /></a>

<p>The GitPod environment will spin up Docker containers with a FusionAuth instance, any dependencies, a terminal and an editor.</p>

<p>Here you are using a bootstrapping feature of FusionAuth called <a href="/docs/get-started/download-and-install/development/kickstart">Kickstart</a>. When FusionAuth comes up for the first time, it will look at the <code>kickstart/kickstart.json</code> file and configure FusionAuth to your specified state.</p>

<p>After the servers start up, you will be presented with a login screen in the GitPod 'Simple Browser', as well other parts of the GitPod environment.</p>

<p>FusionAuth will be initially configured with these settings:</p>

<ul>
<li>Your example username is <code><RemoteValue url={kickstartUri} selector="$.variables.userEmail" /></code> and the password is <code><RemoteValue url={kickstartUri} selector="$.variables.userPassword" /></code>.</li>
<li>Your admin username is <code><RemoteValue url={kickstartUri} selector="$.variables.adminEmail" /></code> and the password is <code><RemoteValue url={kickstartUri} selector="$.variables.adminPassword" /></code>.</li>
<li>The base URL of FusionAuth is based on your GitPod environment.</li>
</ul>


<h2> Summing Up</h2>

<p>To verify that your system is set up, paste the below code into your GitPod terminal. When prompted, log in using the admin credentials (<code><RemoteValue url={kickstartUri} selector="$.variables.adminEmail" /></code> with the password <code><RemoteValue url={kickstartUri} selector="$.variables.userPassword" /></code>). You will see the FusionAuth admin UI.</p>

<Aside type="tip">When you first copy and paste something in the GitPod environment, you may be presented with a popup asking for permission. Look out for that, and accept it to be able to paste commands into the environment.</Aside>

<Code code="startadmin" />

<p>Congratulations! You've got your own FusionAuth instance running in the GitPod cloud.</p>

</dd>

3 changes: 3 additions & 0 deletions astro/src/content/docs/get-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ section: get started
---
import LoginBefore from 'src/diagrams/quickstarts/login-before.astro';
import LoginAfter from 'src/diagrams/quickstarts/login-after.astro';
import Aside from 'src/components/Aside.astro';

## Introduction

Expand All @@ -14,6 +15,8 @@ login, registration, localized email, multi-factor authentication, reporting and

If you're looking for employee login or a replacement for Active Directory - you may be in the wrong place. While FusionAuth can be used for nearly any application, we do not offer native desktop integration and replacing Active Directory is not on our roadmap. However, if you're looking for a solution to manage end users that can perform at scale, then keep reading.

<Aside title="Jump In!">For a quick interactive introduction to FusionAuth, check out our [Start Here](/docs/get-started/start-here) tutorial.</Aside>

Here's a typical application login flow before FusionAuth.

<LoginBefore alt="Login before FusionAuth" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
---
import Code from 'astro/components/Code.astro';

<details>
<summary>Docker</summary>
Point your browser to <Code code="http://localhost:9011/admin" />
</details>

<details>
<summary>GitPod</summary>
<Code code="startadmin" />
</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
---
import Code from 'astro/components/Code.astro';

<details>
<summary>Docker</summary>
Point your browser to <Code code="http://localhost:8080/" />
</details>

<details>
<summary>GitPod</summary>
<Code code="starthere" />
</details>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
---
import Code from 'astro/components/Code.astro';

<details>
<summary>Docker</summary>
Point your browser to <Code code="http://localhost:1080/" />
</details>

<details>
<summary>GitPod</summary>
<Code code="startemail" />
</details>
Loading
Loading