diff --git a/packages/docusaurus/docs/Getting Started/quick-start.md b/packages/docusaurus/docs/Getting Started/quick-start.md new file mode 100644 index 0000000..5fcfee4 --- /dev/null +++ b/packages/docusaurus/docs/Getting Started/quick-start.md @@ -0,0 +1,108 @@ +# Quick Installation Guide + +## Prerequisites + +- A Linux system with root access +- A domain name pointed to your server's IP address +- An email address for Let's Encrypt certificate registration + +## Installation Steps + +### 1. Running the Installer + +The installer must be run as root. If you're not already root, switch to the root user or use sudo: + +```bash +sudo ./installer +``` + +### 2. Basic Configuration + +The installer will prompt you for the following basic information: + +1. **Domain Name**: Enter your fully qualified domain name +2. **Let's Encrypt Email**: Provide an email address for SSL certificate registration + +### 3. Admin User Setup + +You'll need to configure the admin user: + +1. **Admin Email**: Defaults to `admin@yourdomain` but can be customized +2. **Admin Password**: Must meet these requirements: + - At least one uppercase letter + - At least one lowercase letter + - At least one digit + - At least one special character + +### 4. Security Settings + +Configure security options: + +1. **Signup Without Invite**: Choose whether to disable user registration without invites (defaults to disabled) +2. **Organization Creation**: Decide if users can create their own organizations (defaults to enabled) + +### 5. Email Configuration + +Decide whether to enable email functionality: + +If enabled, you'll need to provide: +- SMTP host +- SMTP port (defaults to 587) +- SMTP username +- SMTP password +- No-reply email address + +### 6. Docker Installation + +If Docker isn't already installed, the installer will: + +1. Detect your Linux distribution +2. Offer to install Docker automatically +3. Install the appropriate version for your distribution + +Supported distributions: +- Ubuntu/Debian +- Fedora +- OpenSUSE +- RHEL +- Amazon Linux + +### 7. Container Deployment + +After configuration, the installer will: + +1. Pull the necessary Docker containers +2. Create required directories: + - `config/` + - `config/letsencrypt/` + - `config/db/` + - `config/logs/` +3. Generate configuration files +4. Start the containers using Docker Compose + +## Post-Installation + +After successful installation: + +1. The system will be accessible at your configured domain +2. You can log in using the admin email and password you provided +3. Configuration files will be located in the `config/` directory +4. Docker Compose file will be in the root directory as `docker-compose.yml` + +## Troubleshooting + +Common issues and solutions: + +1. **Permission Denied**: Make sure you're running the installer as root +2. **Docker Installation Fails**: Check your internet connection and system compatibility +3. **Container Startup Fails**: Verify that: + - All required ports are available + - Docker service is running + - Your system has enough resources + +## Notes + +- The installer checks for an existing configuration and won't overwrite it if found +- All inputs have validation to ensure proper formatting +- Docker installation is optional if already present +- The system uses Docker Compose for container orchestration \ No newline at end of file diff --git a/packages/docusaurus/docs/tutorial-basics/_category_.json b/packages/docusaurus/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55..0000000 --- a/packages/docusaurus/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/packages/docusaurus/docs/tutorial-basics/congratulations.md b/packages/docusaurus/docs/tutorial-basics/congratulations.md deleted file mode 100644 index 04771a0..0000000 --- a/packages/docusaurus/docs/tutorial-basics/congratulations.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -sidebar_position: 6 ---- - -# Congratulations! - -You have just learned the **basics of Docusaurus** and made some changes to the **initial template**. - -Docusaurus has **much more to offer**! - -Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**. - -Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610) - -## What's next? - -- Read the [official documentation](https://docusaurus.io/) -- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config) -- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration) -- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout) -- Add a [search bar](https://docusaurus.io/docs/search) -- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase) -- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support) diff --git a/packages/docusaurus/docs/tutorial-basics/create-a-blog-post.md b/packages/docusaurus/docs/tutorial-basics/create-a-blog-post.md deleted file mode 100644 index 550ae17..0000000 --- a/packages/docusaurus/docs/tutorial-basics/create-a-blog-post.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Create a Blog Post - -Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed... - -## Create your first Post - -Create a file at `blog/2021-02-28-greetings.md`: - -```md title="blog/2021-02-28-greetings.md" ---- -slug: greetings -title: Greetings! -authors: - - name: Joel Marcey - title: Co-creator of Docusaurus 1 - url: https://github.com/JoelMarcey - image_url: https://github.com/JoelMarcey.png - - name: Sébastien Lorber - title: Docusaurus maintainer - url: https://sebastienlorber.com - image_url: https://github.com/slorber.png -tags: [greetings] ---- - -Congratulations, you have made your first post! - -Feel free to play around and edit this post as much as you like. -``` - -A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings). diff --git a/packages/docusaurus/docs/tutorial-basics/create-a-document.md b/packages/docusaurus/docs/tutorial-basics/create-a-document.md deleted file mode 100644 index c22fe29..0000000 --- a/packages/docusaurus/docs/tutorial-basics/create-a-document.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Create a Document - -Documents are **groups of pages** connected through: - -- a **sidebar** -- **previous/next navigation** -- **versioning** - -## Create your first Doc - -Create a Markdown file at `docs/hello.md`: - -```md title="docs/hello.md" -# Hello - -This is my **first Docusaurus document**! -``` - -A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello). - -## Configure the Sidebar - -Docusaurus automatically **creates a sidebar** from the `docs` folder. - -Add metadata to customize the sidebar label and position: - -```md title="docs/hello.md" {1-4} ---- -sidebar_label: 'Hi!' -sidebar_position: 3 ---- - -# Hello - -This is my **first Docusaurus document**! -``` - -It is also possible to create your sidebar explicitly in `sidebars.js`: - -```js title="sidebars.js" -export default { - tutorialSidebar: [ - 'intro', - // highlight-next-line - 'hello', - { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], - }, - ], -}; -``` diff --git a/packages/docusaurus/docs/tutorial-basics/create-a-page.md b/packages/docusaurus/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/packages/docusaurus/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/packages/docusaurus/docs/tutorial-basics/deploy-your-site.md b/packages/docusaurus/docs/tutorial-basics/deploy-your-site.md deleted file mode 100644 index 1c50ee0..0000000 --- a/packages/docusaurus/docs/tutorial-basics/deploy-your-site.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -sidebar_position: 5 ---- - -# Deploy your site - -Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**). - -It builds your site as simple **static HTML, JavaScript and CSS files**. - -## Build your site - -Build your site **for production**: - -```bash -npm run build -``` - -The static files are generated in the `build` folder. - -## Deploy your site - -Test your production build locally: - -```bash -npm run serve -``` - -The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/). - -You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**). diff --git a/packages/docusaurus/docs/tutorial-basics/markdown-features.mdx b/packages/docusaurus/docs/tutorial-basics/markdown-features.mdx deleted file mode 100644 index 325f80c..0000000 --- a/packages/docusaurus/docs/tutorial-basics/markdown-features.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -sidebar_position: 4 ---- - -# Markdown Features - -Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**. - -## Front Matter - -Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/): - -```text title="my-doc.md" -// highlight-start ---- -id: my-doc-id -title: My document title -description: My document description -slug: /my-custom-url ---- -// highlight-end - -## Markdown heading - -Markdown text with [links](./hello.md) -``` - -## Links - -Regular Markdown links are supported, using url paths or relative file paths. - -```md -Let's see how to [Create a page](/create-a-page). -``` - -```md -Let's see how to [Create a page](./create-a-page.md). -``` - -**Result:** Let's see how to [Create a page](./create-a-page.md). - -## Images - -Regular Markdown images are supported. - -You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`): - -You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them: - -## Code Blocks - -Markdown code blocks are supported with Syntax highlighting. - -````md -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` -```` - -```jsx title="src/components/HelloDocusaurus.js" -function HelloDocusaurus() { - return

Hello, Docusaurus!

; -} -``` - -## Admonitions - -Docusaurus has a special syntax to create admonitions and callouts: - -```md -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: -``` - -:::tip My tip - -Use this awesome feature option - -::: - -:::danger Take care - -This action is dangerous - -::: - -## MDX and React Components - -[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**: - -```jsx -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`) - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! -``` - -export const Highlight = ({children, color}) => ( - { - alert(`You clicked the color ${color} with label ${children}`); - }}> - {children} - -); - -This is Docusaurus green ! - -This is Facebook blue ! diff --git a/packages/docusaurus/docs/tutorial-extras/_category_.json b/packages/docusaurus/docs/tutorial-extras/_category_.json deleted file mode 100644 index a8ffcc1..0000000 --- a/packages/docusaurus/docs/tutorial-extras/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "Tutorial - Extras", - "position": 3, - "link": { - "type": "generated-index" - } -} diff --git a/packages/docusaurus/docs/tutorial-extras/img/docsVersionDropdown.png b/packages/docusaurus/docs/tutorial-extras/img/docsVersionDropdown.png deleted file mode 100644 index 97e4164..0000000 Binary files a/packages/docusaurus/docs/tutorial-extras/img/docsVersionDropdown.png and /dev/null differ diff --git a/packages/docusaurus/docs/tutorial-extras/img/localeDropdown.png b/packages/docusaurus/docs/tutorial-extras/img/localeDropdown.png deleted file mode 100644 index e257edc..0000000 Binary files a/packages/docusaurus/docs/tutorial-extras/img/localeDropdown.png and /dev/null differ diff --git a/packages/docusaurus/docs/tutorial-extras/manage-docs-versions.md b/packages/docusaurus/docs/tutorial-extras/manage-docs-versions.md deleted file mode 100644 index ccda0b9..0000000 --- a/packages/docusaurus/docs/tutorial-extras/manage-docs-versions.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Manage Docs Versions - -Docusaurus can manage multiple versions of your docs. - -## Create a docs version - -Release a version 1.0 of your project: - -```bash -npm run docusaurus docs:version 1.0 -``` - -The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created. - -Your docs now have 2 versions: - -- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs -- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs** - -## Add a Version Dropdown - -To navigate seamlessly across versions, add a version dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'docsVersionDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The docs version dropdown appears in your navbar: - -![Docs Version Dropdown](./img/docsVersionDropdown.png) - -## Update an existing version - -It is possible to edit versioned docs in their respective folder: - -- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello` -- `docs/hello.md` updates `http://localhost:3000/docs/next/hello` diff --git a/packages/docusaurus/docs/tutorial-extras/translate-your-site.md b/packages/docusaurus/docs/tutorial-extras/translate-your-site.md deleted file mode 100644 index b5a644a..0000000 --- a/packages/docusaurus/docs/tutorial-extras/translate-your-site.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Translate your site - -Let's translate `docs/intro.md` to French. - -## Configure i18n - -Modify `docusaurus.config.js` to add support for the `fr` locale: - -```js title="docusaurus.config.js" -export default { - i18n: { - defaultLocale: 'en', - locales: ['en', 'fr'], - }, -}; -``` - -## Translate a doc - -Copy the `docs/intro.md` file to the `i18n/fr` folder: - -```bash -mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/ - -cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md -``` - -Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French. - -## Start your localized site - -Start your site on the French locale: - -```bash -npm run start -- --locale fr -``` - -Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated. - -:::caution - -In development, you can only use one locale at a time. - -::: - -## Add a Locale Dropdown - -To navigate seamlessly across languages, add a locale dropdown. - -Modify the `docusaurus.config.js` file: - -```js title="docusaurus.config.js" -export default { - themeConfig: { - navbar: { - items: [ - // highlight-start - { - type: 'localeDropdown', - }, - // highlight-end - ], - }, - }, -}; -``` - -The locale dropdown now appears in your navbar: - -![Locale Dropdown](./img/localeDropdown.png) - -## Build your localized site - -Build your site for a specific locale: - -```bash -npm run build -- --locale fr -``` - -Or build your site to include all the locales at once: - -```bash -npm run build -``` diff --git a/stacks/DocusaurusStack.ts b/stacks/DocusaurusStack.ts index fec0be8..84b7e6f 100644 --- a/stacks/DocusaurusStack.ts +++ b/stacks/DocusaurusStack.ts @@ -3,35 +3,40 @@ import * as route53 from "aws-cdk-lib/aws-route53"; import { ViewerProtocolPolicy } from "aws-cdk-lib/aws-cloudfront"; export function DocusaurusStack({ stack }: StackContext) { - const hostedZone = route53.HostedZone.fromLookup(stack, "HostedZone", { - domainName: "fossorial.io", - }); + const hostedZone = route53.HostedZone.fromLookup(stack, "HostedZone", { + domainName: "fossorial.io", + }); - const site = new StaticSite(stack, "DocusaurusSite", { - path: "packages/docusaurus", - buildOutput: "build", - buildCommand: "npm run build", - customDomain: { - domainName: "docs.fossorial.io", - hostedZone: hostedZone.zoneName, - isExternalDomain: false, - }, - cdk: { - distribution: { - defaultBehavior: { - viewerProtocolPolicy: ViewerProtocolPolicy.REDIRECT_TO_HTTPS, - compress: true, + const site = new StaticSite(stack, "DocusaurusSite", { + path: "packages/docusaurus", + buildOutput: "build", + buildCommand: "npm run build", + customDomain: { + domainName: "docs.fossorial.io", + hostedZone: hostedZone.zoneName, + isExternalDomain: false, }, - errorResponses: [ - { - httpStatus: 404, - responseHttpStatus: 404, - responsePagePath: "/404.html", - }, - ], - }, - }, - }); + cdk: { + distribution: { + defaultBehavior: { + viewerProtocolPolicy: ViewerProtocolPolicy.REDIRECT_TO_HTTPS, + compress: true, + }, + errorResponses: [ + { + httpStatus: 403, + responseHttpStatus: 200, + responsePagePath: "/index.html", + }, + { + httpStatus: 404, + responseHttpStatus: 200, + responsePagePath: "/index.html", + }, + ], + }, + }, + }); - stack.addOutputs({}); + stack.addOutputs({}); } \ No newline at end of file