diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index cc034fc932..52ff41759e 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -2,5 +2,3 @@
github: Mahmoudz
open_collective: laradock
-custom: ['paypal.me/mzmmzz']
-patreon: zalt
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 85ca95d7ef..323a49e0d5 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -13,6 +13,6 @@
## Definition of Done Checklist:
-- [] I've read the [Contribution Guide](http://laradock.io/contributing).
-- [] I've updated the **documentation**. (refer to [this](http://laradock.io/contributing/#update-the-documentation-site) for how to do so).
+- [] I've read the [Contribution Guide](https://laradock.io/contributing).
+- [] I've updated the **documentation**. (refer to [this](https://laradock.io/contributing/#update-the-documentation-site) for how to do so).
- [] I enjoyed my time contributing and making developer's life easier :)
diff --git a/.github/home-page-images/custom-sponsors/VeePN.png b/.github/home-page-images/custom-sponsors/VeePN.png
deleted file mode 100644
index efad065de0..0000000000
Binary files a/.github/home-page-images/custom-sponsors/VeePN.png and /dev/null differ
diff --git a/.github/home-page-images/custom-sponsors/sista-ai-icon.png b/.github/home-page-images/custom-sponsors/sista-ai-icon.png
index 30b156a09b..9955b9d969 100644
Binary files a/.github/home-page-images/custom-sponsors/sista-ai-icon.png and b/.github/home-page-images/custom-sponsors/sista-ai-icon.png differ
diff --git a/.github/workflows/build-deploy-docs.yml b/.github/workflows/build-deploy-docs.yml
index dc81ccdf89..56f9a93ac7 100644
--- a/.github/workflows/build-deploy-docs.yml
+++ b/.github/workflows/build-deploy-docs.yml
@@ -25,19 +25,20 @@ jobs:
- name: Checkout Source Code
uses: actions/checkout@v4
- - name: Setup Hugo
- uses: peaceiris/actions-hugo@v2
+ - name: Set up Node.js
+ uses: actions/setup-node@v3
with:
- hugo-version: '0.55.0'
- env:
- ACTIONS_ALLOW_UNSECURE_COMMANDS: true
+ node-version: '18'
- - name: Build Hugo Site
- run: hugo --minify
+ - name: Install DocuSource Dependencies
+ run: npm install
- - name: Deploy Hugo Site to Github Pages
+ - name: Build DocuSource Site
+ run: npm run build
+
+ - name: Deploy DocuSource Site to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
- publish_dir: ./docs
+ publish_dir: ./DOCUMENTATION/build
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 74868e19f5..49b787a91f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,3 +1,3 @@
# Thank you for your consideration
-Checkout out our [contribution guide](http://laradock.io/contributing).
+Checkout out our [contribution guide](https://laradock.io/contributing).
diff --git a/DOCUMENTATION/.gitignore b/DOCUMENTATION/.gitignore
new file mode 100644
index 0000000000..b2d6de3062
--- /dev/null
+++ b/DOCUMENTATION/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/DOCUMENTATION/babel.config.js b/DOCUMENTATION/babel.config.js
new file mode 100644
index 0000000000..e00595dae7
--- /dev/null
+++ b/DOCUMENTATION/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+ presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/DOCUMENTATION/config.toml b/DOCUMENTATION/config.toml
deleted file mode 100644
index d6c3a732dc..0000000000
--- a/DOCUMENTATION/config.toml
+++ /dev/null
@@ -1,87 +0,0 @@
-baseurl = "https://laradock.io/"
-languageCode = "en-us"
-publishDir = "../docs"
-title = "Laradock"
-theme = "hugo-material-docs"
-metadataformat = "yaml"
-canonifyurls = true
-uglyurls = true
-# Enable Google Analytics by entering your tracking id
-googleAnalytics = "UA-37514928-9"
-
-[params]
- # General information
- author = "Mahmoud Zalt"
- description = "Full PHP development environment for Docker."
- copyright = ""
-
- # Repository
- provider = ""
- repo_url = "https://github.com/laradock/laradock"
-
- version = ""
- logo = "images/favicons/ms-icon-310x310.png"
- favicon = "images/favicons/favicon.ico"
-
- permalink = "#"
-
- # Custom assets
- custom_css = ["custom-style.css"]
- custom_js = []
-
- # Syntax highlighting theme
- highlight_css = ""
-
- [params.palette]
- primary = "deep-purple"
- accent = "purple"
-
- [params.font]
- text = "Doctarine"
- code = "Source Code Pro"
-
-[social]
- twitter = ""
- github = "laradock/laradock"
- email = "support@laradock.io"
-
-# ------- MENU START -----------------------------------------
-
-[[menu.main]]
- name = "Introduction"
- url = "introduction/"
- weight = 1
-
-[[menu.main]]
- name = "Getting Started"
- url = "getting-started/"
- weight = 2
-
-[[menu.main]]
- name = "Documentation"
- url = "documentation/"
- weight = 3
-
-[[menu.main]]
- name = "Help & Questions"
- url = "help/"
- weight = 4
-
-[[menu.main]]
- name = "Related Projects"
- url = "related-projects/"
- weight = 5
-
-[[menu.main]]
- name = "Contributions"
- url = "contributing/"
- weight = 6
-
-# ------- MENU END -----------------------------------------
-
-[blackfriday]
- smartypants = true
- fractions = true
- smartDashes = true
- plainIDAnchors = true
-
diff --git a/DOCUMENTATION/content/introduction/index.md b/DOCUMENTATION/content/introduction/index.md
deleted file mode 100644
index aae281f6f8..0000000000
--- a/DOCUMENTATION/content/introduction/index.md
+++ /dev/null
@@ -1,563 +0,0 @@
----
-title: Introduction
-type: index
-weight: 1
----
-
-Laradock is a full PHP development environment for Docker.
-
-It supports a variety of common services, all pre-configured to provide a ready PHP development environment.
-
-
-
----
-### Use Docker First - Learn About It Later!
----
-
-
-## Features
-
-- Easy switch between PHP versions: 8.1, 8.0, 7.4, 7.3, 7.2, 7.1, 5.6...
-- Choose your favorite database engine: MySQL, Postgres, MariaDB...
-- Run your own stack: Memcached, HHVM, RabbitMQ...
-- Each software runs on its own container: PHP-FPM, NGINX, PHP-CLI...
-- Easy to customize any container, with simple edits to the `Dockerfile`.
-- All Images extend from an official base Image. (Trusted base Images).
-- Pre-configured NGINX to host any code at your root directory.
-- Can use Laradock per project, or single Laradock for all projects.
-- Easy to install/remove software's in Containers using environment variables.
-- Clean and well-structured Dockerfiles (`Dockerfile`).
-- The Latest version of the Docker Compose file (`docker-compose`).
-- Everything is visible and editable.
-- Fast Images Builds.
-
-
-
-
-
-
-## Quick Overview
-
-Let's see how easy it is to setup our demo stack `PHP`, `NGINX`, `MySQL`, `Redis` and `Composer`:
-
-1 - Clone Laradock inside your PHP project:
-
-```shell
-git clone https://github.com/Laradock/laradock.git
-```
-
-2 - Enter the laradock folder and rename `.env.example` to `.env`.
-
-```shell
-cp .env.example .env
-```
-
-3 - Run your containers:
-
-```shell
-docker-compose up -d nginx mysql phpmyadmin redis workspace
-```
-
-4 - Open your project's `.env` file and set the following:
-
-```shell
-DB_HOST=mysql
-REDIS_HOST=redis
-QUEUE_HOST=beanstalkd
-```
-
-5 - Open your browser and visit localhost: `http://localhost`.
-
-```shell
-That's it! enjoy :)
-```
-
-
-
-
-
-## Supported Services
-
-> Laradock, adheres to the 'separation of concerns' principle, thus it runs each software on its own Docker Container.
-> You can turn On/Off as many instances as you want without worrying about the configurations.
-
-> To run a chosen container from the list below, run `docker-compose up -d {container-name}`.
-> The container name `{container-name}` is the same as its folder name. Example to run the "PHP FPM" container, use the name "php-fpm".
-
-- **Web Servers:**
- - NGINX
- - Apache2
- - Caddy
-
-- **Load Balancers:**
- - HAProxy
- - Traefik
-
-- **PHP Compilers:**
- - PHP FPM
- - HHVM
-
-- **Database Management Systems:**
- - MySQL
- - PostgreSQL
- - PostGIS
- - MariaDB
- - Percona
- - MSSQL
- - MongoDB
- - MongoDB Web UI
- - Neo4j
- - CouchDB
- - RethinkDB
- - Cassandra
-
-
-- **Database Management Apps:**
- - PhpMyAdmin
- - Adminer
- - PgAdmin
-
-- **Cache Engines:**
- - Redis
- - Redis Web UI
- - Redis Cluster
- - Memcached
- - Aerospike
- - Varnish
-
-- **Message Brokers:**
- - RabbitMQ
- - RabbitMQ Admin Console
- - Beanstalkd
- - Beanstalkd Admin Console
- - Eclipse Mosquitto
- - PHP Worker
- - Laravel Horizon
- - Gearman
- - Amazon Simple Queue Service
-
-- **Mail Servers:**
- - Mailu
- - MailCatcher
- - Mailhog
- - MailDev
-
-- **Log Management:**
- - GrayLog
-
-- **Testing:**
- - Selenium
-
-- **Monitoring:**
- - Grafana
- - NetData
-
-- **Search Engines:**
- - ElasticSearch
- - Apache Solr
- - Manticore Search
-
-- **IDE's**
- - ICE Coder
- - Theia
- - Web IDE
-
-- **Miscellaneous:**
- - Workspace *(Laradock container that includes a rich set of pre-configured useful tools)*
- - `PHP CLI`
- - `Composer`
- - `Git`
- - `Vim`
- - `xDebug`
- - `Linuxbrew`
- - `Node`
- - `V8JS`
- - `Gulp`
- - `SQLite`
- - `Laravel Envoy`
- - `Deployer`
- - `Yarn`
- - `SOAP`
- - `Drush`
- - `Wordpress CLI`
- - `dnsutils`
- - Apache ZooKeeper *(Centralized service for distributed systems to a hierarchical key-value store)*
- - Kibana *(Visualize your Elasticsearch data and navigate the Elastic Stack)*
- - Dejavu *(Edit your Elasticsearch data)*
- - LogStash *(Server-side data processing pipeline that ingests data from a multitude of sources simultaneously)*
- - Jenkins *(automation server, that provides plugins to support building, deploying and automating any project)*
- - Certbot *(Automatically enable HTTPS on your website)*
- - Swoole *(Production-Grade Async programming Framework for PHP)*
- - SonarQube *(continuous inspection of code quality to perform automatic reviews with static analysis of code to detect bugs and more)*
- - Gitlab *(A single application for the entire software development lifecycle)*
- - PostGIS *(Database extender for PostgreSQL. It adds support for geographic objects allowing location queries to be run in SQL)*
- - Blackfire *(Empowers all PHP developers and IT/Ops to continuously verify and improve their app's performance)*
- - Laravel Echo *(Bring the power of WebSockets to your Laravel applications)*
- - Mercure *(Server-sent events)*
- - Phalcon *(A PHP web framework based on the model–view–controller pattern)*
- - Minio *(Cloud storage server released under Apache License v2, compatible with Amazon S3)*
- - AWS EB CLI *(CLI that helps you deploy and manage your AWS Elastic Beanstalk applications and environments)*
- - Thumbor *(Photo thumbnail service)*
- - IPython *(Provides a rich architecture for interactive computing)*
- - Jupyter Hub *(Jupyter notebook for multiple users)*
- - Portainer *(Build and manage your Docker environments with ease)*
- - Docker Registry *(The Docker Registry implementation for storing and distributing Docker images)*
- - Docker Web UI *(A browser-based solution for browsing and modifying a private Docker registry)*
-
-You can choose, which tools to install in your workspace container and other containers, from the `.env` file.
-
-
-> If you modify `docker-compose.yml`, `.env` or any `dockerfile` file, you must re-build your containers, to see those effects in the running instance.
-
-
-
-*If you can't find your Software in the list, build it yourself and submit it. Contributions are welcomed :)*
-
----
-
-
-
-
-
-
-
-
-
-
-## Join Us
-
-[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-
-[![Gitpod](https://img.shields.io/badge/Gitpod-ready--to--code-blue)](https://gitpod.io/#https://github.com/laradock/laradock)
-
----
-
-
-## Awesome People
-
-Laradock is an MIT-licensed open source project with its ongoing development made possible entirely by the support of all these smart and generous people, from code contributors to financial contributors. 💜
-
-
-### Project Maintainers
-
-
-
-### Code Contributors
-
-[![Laradock Contributors][contributors-src]][contributors-href]
-
-### Financial Contributors
-
-[![Open Collective backers][backers-src]][backers-href]
-
-You can support us using any of the methods below:
-
-1: [Open Collective](https://opencollective.com/laradock)
-
-2: [Paypal](https://paypal.me/mzmmzz)
-
-3: [Github Sponsors](https://github.com/sponsors/Mahmoudz)
-
-4: [Patreon](https://www.patreon.com/zalt)
-
----
-
-
-## Sponsors
-
-Sponsoring is an act of giving in a different fashion. 🌱
-
-
-### Gold Sponsors
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-### Silver Sponsors
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-### Bronze Sponsors
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-You can sponsor us using any of the methods below:
-
-1: Sponsor via [Open Collective](https://opencollective.com/laradock/).
-
-2: Email us at support@laradock.io .
-
-*Sponsors logos are displayed on the [github repository](https://github.com/laradock/laradock/) page and the [documentation website](http://laradock.io/) home page.*
-
-## License
-
-[MIT](https://github.com/laradock/laradock/blob/master/LICENSE) © Mahmoud Zalt
-
-
-[comment]: # (Open Collective Tiers)
-
-[contributors-src]: https://opencollective.com/laradock/contributors.svg?width=890&button=false&isActive=true
-[contributors-href]: https://github.com/laradock/laradock/graphs/contributors
-[backers-src]: https://opencollective.com/laradock/tiers/awesome-backers.svg?width=890&button=false&isActive=true
-[backers-href]: https://opencollective.com/laradock#contributors
-
-[gold-sponsors-src]: https://opencollective.com/laradock/tiers/gold-sponsors.svg?avatarHeight=80&width=890&button=false&isActive=true
-[gold-sponsors-href]: https://opencollective.com/laradock#contributors
-[silver-sponsors-src]: https://opencollective.com/laradock/tiers/silver-sponsors.svg?avatarHeight=64&width=890&button=false&isActive=true
-[silver-sponsors-href]: https://opencollective.com/laradock#contributors
-[bronze-sponsors-src]: https://opencollective.com/laradock/tiers/bronze-sponsors.svg?avatarHeight=48&width=890&button=false&isActive=true
-[bronze-sponsors-href]: https://opencollective.com/laradock#contributors
-
-
-
-
-
-
-
-
-
diff --git a/DOCUMENTATION/docs/Intro.md b/DOCUMENTATION/docs/Intro.md
new file mode 100644
index 0000000000..9317b8d7dc
--- /dev/null
+++ b/DOCUMENTATION/docs/Intro.md
@@ -0,0 +1,438 @@
+---
+sidebar_position: 1
+title: Introduction
+---
+
+![Docker Image](/img/laradock/laradock-logo.jpg)
+
+Laradock is a full PHP development environment for Docker.
+
+We offer a range of popular, pre-configured services that provide a ready-to-use PHP development environment in seconds.
+
+---
+### Use Docker First - Learn About It Later!
+---
+
+
+## Features
+
+- **Seamless PHP Version Switching**: Effortlessly switch between PHP versions (8.1, 8.0, 7.4, 7.3, 7.2, 7.1, 5.6...).
+- **Flexible Database Choices**: Pick your preferred database engine, whether it's MySQL, Postgres, MariaDB, and more.
+- **Customizable Stacks**: Run your own stack with services like Memcached, HHVM, RabbitMQ, and more.
+- **Isolated Containers**: Each software runs in its own container, ensuring clean separation and easy management.
+- **Simple Customization**: Easily tweak any container by editing its `Dockerfile`.
+- **Trusted Base Images**: All images extend from official base images, ensuring reliability and security.
+- **Pre-configured Web Servers**: Ready-to-use NGINX setup to host your code right from the root directory.
+- **Project Flexibility**: Use Laradock per project or a single Laradock setup for all your projects.
+- **Environment Variable Management**: Easily install or remove software in containers using environment variables.
+- **Clean Dockerfiles**: Well-structured and easy-to-understand Dockerfiles (`Dockerfile`).
+- **Latest Docker Compose**: Always up-to-date with the latest version of the Docker Compose file (`docker-compose`).
+- **Full Transparency**: Everything is visible and editable, giving you full control over your environment.
+- **Fast Builds**: Enjoy quick image builds to get your environment up and running in no time.
+
+
+
+
+## Supported Services
+
+> Laradock, adheres to the 'separation of concerns' principle, thus it runs each software on its own Docker Container.
+> You can turn On/Off as many instances as you want without worrying about the configurations.
+
+> To run a chosen container from the list below, run `docker-compose up -d {container-name}`.
+> The container name `{container-name}` is the same as its folder name. Example to run the "PHP FPM" container, use the name "php-fpm".
+
+
+
+| Category | Services (Containers) |
+|---------------------------|--------------------------------------------------------------------------|
+| **Web Servers** | NGINX, Apache2, Caddy |
+| **Load Balancers** | HAProxy, Traefik |
+| **PHP Compilers** | PHP FPM, HHVM |
+| **Database Management Systems** | MySQL, PostgreSQL (PostGIS), MariaDB, Percona, MSSQL, MongoDB, Neo4j, CouchDB, RethinkDB, Cassandra |
+| **Database Management Tools** | PhpMyAdmin, Adminer, PgAdmin, MongoDB Web UI |
+| **Cache Engines** | Redis, Redis Web UI, Redis Cluster, Memcached, Aerospike, Varnish |
+| **Message Brokers** | RabbitMQ, RabbitMQ Admin Console, Beanstalkd, Beanstalkd Admin Console, Eclipse Mosquitto, Gearman |
+| **Log Management** | GrayLog, Kibana, LogStash |
+| **Search Engines** | ElasticSearch, Apache Solr, Manticore Search, Dejavu |
+| **PHP Extensions** | Swoole, Blackfire, Phalcon, PHP Worker, Laravel Horizon |
+| **Mail Servers** | Mailu, MailCatcher, Mailhog, MailDev |
+| **Real-time Communication** | Laravel Echo, Mercure |
+| **Monitoring** | Grafana, NetData |
+| **Coordination Services** | Apache ZooKeeper |
+| **Container Management** | Portainer, Docker Registry, Docker Web UI |
+| **CI/CD Tools** | Jenkins, SonarQube, Gitlab |
+| **Cloud Tools** | AWS EB CLI, Amazon Simple Queue Service |
+| **Image Processing** | Thumbor |
+| **Interactive Computing** | IPython, Jupyter Hub |
+| **Security Tools** | Certbot |
+| **Object Storage** | Minio |
+| **Testing** | Selenium |
+| **IDEs** | ICE Coder, Theia, Web IDE |
+| (**Laradock Workspace**) | PHP CLI, Composer, Git, Vim, xDebug, Linuxbrew, Node, V8JS, Gulp, SQLite, Laravel Envoy, Deployer, Yarn, SOAP, Drush, Wordpress CLI, dnsutils |
+
+
+
+You can choose, which tools to install in your workspace container and other containers, from the `.env` file.
+
+
+*If you modify `docker-compose.yml`, `.env` or any `dockerfile` file, you must re-build your containers, to see those effects in the running instance.*
+
+
+
+> If you can't find your Software in the list, build it yourself and submit it. Contributions are welcomed :)
+
+
+
+
+## Quick Overview
+
+Let's see how easy it is to setup our demo stack `PHP`, `NGINX`, `MySQL`, `Redis` and `Composer`:
+
+1 - Clone Laradock inside your PHP project:
+
+```shell
+git clone https://github.com/Laradock/laradock.git
+```
+
+2 - Enter the laradock folder and rename `.env.example` to `.env`.
+
+```shell
+cp .env.example .env
+```
+
+3 - Run your containers:
+
+```shell
+docker-compose up -d nginx mysql phpmyadmin redis workspace
+```
+
+4 - Open your project's `.env` file and set the following:
+
+```shell
+DB_HOST=mysql
+REDIS_HOST=redis
+QUEUE_HOST=beanstalkd
+```
+
+5 - Open your browser and visit localhost: `http://localhost`.
+
+```shell
+That's it! enjoy :)
+```
+
+
+
+---
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Awesome People
+
+Laradock is an MIT-licensed open source project with its ongoing development made possible entirely by the support of you and all these awesome people. 💜
+
+
+### Project Maintainers
+
+
+
+
+
+### Code Contributors
+
+[![Laradock Contributors](https://opencollective.com/laradock/contributors.svg?width=890&button=false&isActive=true)](https://github.com/laradock/laradock/graphs/contributors)
+
+### Financial Contributors (Backers)
+
+[![Open Collective backers](https://opencollective.com/laradock/tiers/awesome-backers.svg?width=800&avatarHeight=55&button=false&isActive=true)](https://opencollective.com/laradock#contributors)
+
+
+---
+
+
+
+## Sponsors
+
+
+
+
+
+### Diamond Sponsors
+
+
+
+
+### Gold Sponsors
+
+
+
+
+
+
+
+
+
+### Silver Sponsors
+
+
+
+### Bronze Sponsors
+
+
+
+
+
+### Sponsorship Support
+
+Sponsoring is an act of giving in a unique way. 🌱
+You can support us using any of the methods below:
+
+**1:** [Open Collective](https://opencollective.com/laradock)
+*Available for all tiers:* Gold, Silver, Bronze, and Backers (Financial Contributors). **Preferred method.**
+
+**2:** [Email](mailto:support@laradock.io)
+*Available for Diamond sponsors only.*
+
+**3:** [GitHub Sponsors](https://github.com/sponsors/Mahmoudz)
+*Supports the creator of the project directly:* Ideal for personal support of the project creator.
+
+## License
+
+[MIT](https://github.com/laradock/laradock/blob/master/LICENSE) © [Mahmoud Zalt](https://zalt.me/)
+
+
diff --git a/DOCUMENTATION/content/contributing/index.md b/DOCUMENTATION/docs/contributing.md
similarity index 81%
rename from DOCUMENTATION/content/contributing/index.md
rename to DOCUMENTATION/docs/contributing.md
index b2d05d614e..798f74e27d 100644
--- a/DOCUMENTATION/content/contributing/index.md
+++ b/DOCUMENTATION/docs/contributing.md
@@ -1,7 +1,6 @@
---
+sidebar_position: 100
title: Contributions
-type: index
-weight: 6
---
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/laradock/laradock)
@@ -36,37 +35,28 @@ You can request a new feature by submitting an [Issue](https://github.com/larado
-
## Update the Documentation (Site)
-Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.
-
-Go the `DOCUMENTATION/content` and search for the markdown file you want to edit
-
-Note: Every folder represents a section in the sidebar "Menu". And every page and sidebar has a `weight` number to show it's position in the site.
-
-To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/config.toml` toml file.
-
-> The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).
+Laradock uses [Docusaurus](https://docusaurus.io/) as its documentation site generator.
+Navigate to the `DOCUMENTATION/docs` directory to locate and edit the Markdown files for each section of the documentation.
+**Note:** Each folder under `docs` represents a section in the sidebar menu, with a `sidebar_position` field in the frontmatter of each file that determines its order.
-### Host the documentation locally
+> The documentation site is auto-generated and deployed to the `gh-pages` branch by GitHub Actions when changes are pushed to the `master` branch.
-**Option 1: Use Hugo Docker Image:**
+### Host the Documentation Locally
-1. Update the `DOCUMENTATION/content`.
-2. Go to `DOCUMENTATION/`.
-3. Run `docker run --rm -it -v $PWD:/src -p 1313:1313 -u hugo jguyomard/hugo-builder hugo server -w --bind=0.0.0.0`
-4. Visit [http://localhost:1313/](http://localhost:1313/)
+1. Make your changes are made in the `DOCUMENTATION/docs` directory (if you changed anything).
+2. Navigate to `DOCUMENTATION/`.
+3. Run the following command to start a local Docusaurus server:
+ ```
+ npm run start
+ ```
+4. Visit [http://localhost:3000/](http://localhost:3000/) to view the documentation site locally.
-**Option 2: Install Hugo Locally:**
+This setup will allow you to preview your changes in real time.
-1. Install [Hugo](https://gohugo.io/) on your machine.
-2. Update the `DOCUMENTATION/content`.
-3. Delete the `/docs` folder from the root.
-4. Go to `DOCUMENTATION/`.
-5. Run the `hugo` command to generate the HTML docs inside a new `/docs` folder.
## Support new Software (Add new Container)
@@ -127,7 +117,7 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI
-
+
@@ -213,5 +203,5 @@ After your pull request is merged, you can safely delete your branch and pull th
-
+
## Happy Coding :)
diff --git a/DOCUMENTATION/content/getting-started/index.md b/DOCUMENTATION/docs/getting-started.md
similarity index 95%
rename from DOCUMENTATION/content/getting-started/index.md
rename to DOCUMENTATION/docs/getting-started.md
index dc2574f1af..057a398f37 100644
--- a/DOCUMENTATION/content/getting-started/index.md
+++ b/DOCUMENTATION/docs/getting-started.md
@@ -1,7 +1,6 @@
---
+sidebar_position: 2
title: Getting Started
-type: index
-weight: 2
---
## Requirements
@@ -38,7 +37,7 @@ git submodule add https://github.com/Laradock/laradock.git
Note: If you are not using Git yet for your project, you can use `git clone` instead of `git submodule `.
-*To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/documentation/#track-your-laradock-changes)*
+*To keep track of your Laradock changes, between your projects and also keep Laradock updated [check these docs](/docs/usage#track-your-laradock-changes)*
2 - Make sure your folder structure should look like this:
@@ -148,18 +147,18 @@ If you use Chrome 63 or above for development, don't use `.dev`. [Why?](https://
If you are using **Docker Toolbox** (VM), do one of the following:
-- Upgrade to [Docker Desktop](https://www.docker.com/products/docker-desktop/) for Mac/Windows (Recommended). Check out [Upgrading Laradock](/documentation/#upgrading-laradock)
+- Upgrade to [Docker Desktop](https://www.docker.com/products/docker-desktop/) for Mac/Windows (Recommended). Check out [Upgrading Laradock](/docs/usage/#upgrading-laradock)
- Use Laradock v3.\*. Visit the [Laradock-ToolBox](https://github.com/laradock/laradock/tree/LaraDock-ToolBox) branch. *(outdated)*
-
+
We recommend using a Docker Engine version which is newer than 19.03.0.
-
+
->**Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](/documentation/#Build-Re-build-Containers) in order to prevent as much errors as possible.
+>**Warning:** If you used an older version of Laradock it's highly recommended to rebuild the containers you need to use [see how you rebuild a container](/docs/usage/#Build-Re-build-Containers) in order to prevent as much errors as possible.
-
+
1 - Enter the laradock folder and copy `.env.example` to `.env`
@@ -189,7 +188,7 @@ You can select your own combination of containers from [this list](https://larad
*(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers).*
-
+
3 - Enter the Workspace container, to execute commands like (Artisan, Composer, PHPUnit, Gulp, ...)
```bash
@@ -210,7 +209,7 @@ docker-compose exec --user=laradock workspace bash
*You can change the PUID (User id) and PGID (group id) variables from the `.env` file)*
-
+
4 - Update your project configuration to use the database host
Open your PHP project's `.env` file or whichever configuration file you are reading from, and set the database host `DB_HOST` to `mysql`:
@@ -224,7 +223,7 @@ Or you can change them and rebuild the container.
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*
-
+
5 - Open your browser and visit your localhost address.
Make sure you add use the right port number as provided by your running server.
diff --git a/DOCUMENTATION/content/help/index.md b/DOCUMENTATION/docs/help.md
similarity index 90%
rename from DOCUMENTATION/content/help/index.md
rename to DOCUMENTATION/docs/help.md
index 8f3e655779..ac214ade74 100644
--- a/DOCUMENTATION/content/help/index.md
+++ b/DOCUMENTATION/docs/help.md
@@ -1,24 +1,26 @@
---
-title: Help & Questions
-type: index
-weight: 4
+sidebar_position: 4
+title: Help
---
-Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get help and support from the community.
+
+# Get Help
+
+Open an [issue](https://github.com/laradock/laradock/issues) on Github (will be labeled as Question) and discuss it with people on [Gitter](https://gitter.im/Laradock/laradock).
-[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-You can as well can open an [issue](https://github.com/laradock/laradock/issues) on Github (will be labeled as Question) and discuss it with people on [Gitter](https://gitter.im/Laradock/laradock).
+Optionally: Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get support from the community.
+[![Gitter](https://badges.gitter.im/Laradock/laradock.svg)](https://gitter.im/Laradock/laradock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-
+
# Common Problems
*Here's a list of the common problems you might face, and the possible solutions.*
-
+
## I see a blank (white) page instead of the Laravel 'Welcome' page!
Run the following command from the Laravel root directory:
@@ -32,7 +34,7 @@ sudo chmod -R 777 storage bootstrap/cache
-
+
## I see "Welcome to nginx" instead of the Laravel App!
Use `http://127.0.0.1` instead of `http://localhost` in your browser.
@@ -42,7 +44,7 @@ Use `http://127.0.0.1` instead of `http://localhost` in your browser.
-
+
## I see an error message containing (address already in use) or (port is already allocated)
Make sure the ports for the services that you are trying to run (22, 80, 443, 3306, etc.) are not being used already by other programs on the host, such as a built in `apache`/`httpd` service or other development tools you have installed.
@@ -52,7 +54,7 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
-
+
## I get NGINX error 404 Not Found on Windows.
1. Go to docker Settings on your Windows machine.
@@ -65,7 +67,7 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
-
+
## The time in my services does not match the current time
1. Make sure you've [changed the timezone](#Change-the-timezone).
@@ -76,7 +78,7 @@ Make sure the ports for the services that you are trying to run (22, 80, 443, 33
-
+
## I get MySQL connection refused
This error sometimes happens because your Laravel application isn't running on the container localhost IP (Which is 127.0.0.1). Steps to fix it:
@@ -101,7 +103,7 @@ WORKSPACE_NPM_REGISTRY=https://registry.npmmirror.com
WORKSPACE_COMPOSER_REPO_PACKAGIST=https://packagist.phpcomposer.com
```
-
+
## I got (Module build failed: Error: write EPIPE) while compiling react application
diff --git a/DOCUMENTATION/content/related-projects/index.md b/DOCUMENTATION/docs/related-projects.md
similarity index 97%
rename from DOCUMENTATION/content/related-projects/index.md
rename to DOCUMENTATION/docs/related-projects.md
index f994205272..22f4bb78e6 100644
--- a/DOCUMENTATION/content/related-projects/index.md
+++ b/DOCUMENTATION/docs/related-projects.md
@@ -1,11 +1,12 @@
---
+sidebar_position: 50
title: Related Projects
-type: index
-weight: 5
---
-## Laradock Related Projects
+![Docker Image](/img/laradock/laradock-abstract.jpg)
+
+## Laradock Related Projects
* [Docker Stacks](https://github.com/sfx101/docker-stacks): A GUI for managing Laradock. (by [Subhadip Naskar](https://github.com/sfx101))
* [Laradock CLI](https://github.com/lorinlee/laradock-cli): A CLI for managing Laradock. (by [Lorin Lee](https://github.com/lorinlee))
@@ -44,6 +45,6 @@ weight: 5
-
+
> Feel free to submit a PR for listing your project here.
diff --git a/DOCUMENTATION/content/documentation/index.md b/DOCUMENTATION/docs/usage.md
similarity index 97%
rename from DOCUMENTATION/content/documentation/index.md
rename to DOCUMENTATION/docs/usage.md
index 2eeaf94fcf..e963e901bb 100644
--- a/DOCUMENTATION/content/documentation/index.md
+++ b/DOCUMENTATION/docs/usage.md
@@ -1,7 +1,6 @@
---
-title: Documentation
-type: index
-weight: 3
+sidebar_position: 3
+title: Usage
---
@@ -25,7 +24,7 @@ docker-compose ps
-
+
## Close all running Containers
```bash
@@ -43,7 +42,7 @@ docker-compose stop {container-name}
-
+
## Delete all existing Containers
```bash
@@ -55,7 +54,7 @@ docker-compose down
-
+
## Enter a Container
@@ -88,7 +87,7 @@ docker-compose exec mysql mysql -udefault -psecret
-
+
## Edit default Container config
@@ -117,12 +116,12 @@ Change Redis default port to 1111:
-
+
## Edit a Docker Image
1 - Find the `Dockerfile` of the image you want to edit,
-
+
example for `mysql` it will be `mysql/Dockerfile`.
2 - Edit the file the way you want.
@@ -140,7 +139,7 @@ More info on Containers rebuilding [here](#Build-Re-build-Containers).
-
+
## Build/Re-build Containers
@@ -162,7 +161,7 @@ You might use the `--no-cache` option if you want full rebuilding (`docker-compo
-
+
## Add more Docker Images
@@ -173,7 +172,7 @@ To add an image (software), just edit the `docker-compose.yml` and add your cont
-
+
## View the Log files
The NGINX Log file is stored in the `logs/nginx` directory.
@@ -195,7 +194,7 @@ More [options](https://docs.docker.com/compose/reference/logs/)
-
+
@@ -221,7 +220,7 @@ docker build --no-cache {container-name}
-
+
## Change the (PHP-FPM) Version
@@ -256,7 +255,7 @@ docker-compose build php-fpm
-
+
## Change the PHP-CLI Version
@@ -284,20 +283,20 @@ docker-compose build workspace
Change the PHP-CLI Version
-
+
## Install xDebug
1 - First install `xDebug` in the Workspace and the PHP-FPM Containers:
-
+
a) open the `.env` file
-
+
b) search for the `WORKSPACE_INSTALL_XDEBUG` argument under the Workspace settings
-
+
c) set it to `true`
-
+
d) search for the `PHP_FPM_INSTALL_XDEBUG` argument under the PHP-FPM settings
-
+
e) set it to `true`
2 - Re-build the containers `docker-compose build workspace php-fpm`
@@ -321,7 +320,7 @@ PHP_FPM_INSTALL_XDEBUG=true
-
+
## Start/Stop xDebug:
@@ -337,20 +336,20 @@ Note: If `.php-fpm/xdebug` doesn't execute and gives `Permission Denied` error t
-
+
## Install pcov
1 - First install `pcov` in the Workspace and the PHP-FPM Containers:
-
+
a) open the `.env` file
-
+
b) search for the `WORKSPACE_INSTALL_PCOV` argument under the Workspace Container
-
+
c) set it to `true`
-
+
d) search for the `PHP_FPM_INSTALL_PCOV` argument under the PHP-FPM Container
-
+
e) set it to `true`
2 - Re-build the containers `docker-compose build workspace php-fpm`
@@ -360,13 +359,13 @@ of the [README](https://github.com/krakjoe/pcov)
-
+
## Install phpdbg
Install `phpdbg` in the Workspace and the PHP-FPM Containers:
-
+
1 - Open the `.env`.
2 - Search for `WORKSPACE_INSTALL_PHPDBG`.
@@ -375,20 +374,20 @@ Install `phpdbg` in the Workspace and the PHP-FPM Containers:
4 - Do the same for `PHP_FPM_INSTALL_PHPDBG`
-```dotenv
+```dotenv
WORKSPACE_INSTALL_PHPDBG=true
```
```dotenv
PHP_FPM_INSTALL_PHPDBG=true
```
-
+
## Install Github Copilot Cli
### Note: You must have Github Copilot access to use this feature.
Install `gh-cli` in the Workspace Container:
-
+
1 - Open the `.env`.
2 - Search for `WORKSPACE_INSTALL_GITHUB_CLI`.
@@ -420,20 +419,20 @@ gh auth login
-
+
## Install ionCube Loader
1 - First install `ionCube Loader` in the Workspace and the PHP-FPM Containers:
-
+
a) open the `.env` file
-
+
b) search for the `WORKSPACE_INSTALL_IONCUBE` argument under the Workspace Container
-
+
c) set it to `true`
-
+
d) search for the `PHP_FPM_INSTALL_IONCUBE` argument under the PHP-FPM Container
-
+
e) set it to `true`
2 - Re-build the containers `docker-compose build workspace php-fpm`
@@ -444,18 +443,18 @@ Always download the latest version of [Loaders for ionCube ](http://www.ioncube.
-
+
## Install Deployer
> A deployment tool for PHP.
1 - Open the `.env` file
-
+
2 - Search for the `WORKSPACE_INSTALL_DEPLOYER` argument under the Workspace Container
-
+
3 - Set it to `true`
-
+
4 - Re-build the containers `docker-compose build workspace`
@@ -463,7 +462,7 @@ Always download the latest version of [Loaders for ionCube ](http://www.ioncube.
-
+
## Install SonarQube
@@ -471,15 +470,15 @@ Always download the latest version of [Loaders for ionCube ](http://www.ioncube.
> An automatic code review tool.
SonarQube® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
-
+
1 - Open the `.env` file
-
+
2 - Search for the `SONARQUBE_HOSTNAME=sonar.example.com` argument
-
+
3 - Set it to your-domain `sonar.example.com`
-
+
4 - `docker-compose up -d sonarqube`
-
+
5 - Open your browser: http://localhost:9000/
Troubleshooting:
@@ -500,7 +499,7 @@ docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/son
-
+
@@ -508,7 +507,7 @@ docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/son
-
+
## Prepare Laradock for Production
@@ -533,7 +532,7 @@ To learn more about how Docker publishes ports, please read [this excellent post
-
+
@@ -581,7 +580,7 @@ cd my-cool-app
-
+
## Run Artisan Commands
@@ -631,7 +630,7 @@ vue ui
-
+
## Run Laravel Queue Worker
@@ -648,7 +647,7 @@ docker-compose up -d php-worker
-
+
## Run Laravel Scheduler
@@ -667,7 +666,7 @@ This way is suggested when you don't want to start workspace in production envir
```bash
docker-compose up -d php-worker
```
-
+
## Use Browsersync
@@ -695,7 +694,7 @@ mix.browserSync({
-
+
## Use Mailu
@@ -715,7 +714,7 @@ MAILU_HOSTNAMES=mail.laradock.io
4. Open your browser and visit `http://YOUR_DOMAIN`.
-
+
## Use NetData
@@ -727,7 +726,7 @@ docker-compose up -d netdata
2. Open your browser and visit the localhost on port **19999**: `http://localhost:19999`
-
+
## Use Metabase
@@ -743,7 +742,7 @@ docker-compose up -d netdata
-
+
## Use Jenkins
@@ -771,7 +770,7 @@ You may wanna change the default security configuration, so go to `http://localh
-
+
## Use Redis
@@ -815,7 +814,7 @@ You may wanna change the default security configuration, so go to `http://localh
-
+
## Use Redis Cluster
1. First make sure you run the Redis-Cluster Container (`redis-cluster`) with the `docker-compose up` command.
@@ -843,7 +842,7 @@ You may wanna change the default security configuration, so go to `http://localh
],
```
-
+
## Use Varnish
@@ -897,9 +896,9 @@ Keep in mind that varnish server must be built after Nginx cause varnish checks
#### FAQ:
-1. How to purge cache?
-run from any cli: `curl -X PURGE https://yourwebsite.com/`.
-2. How to reload varnish?
+1. How to purge cache?
+run from any cli: `curl -X PURGE https://yourwebsite.com/`.
+2. How to reload varnish?
`docker container exec proxy varnishreload`
3. Which varnish commands are allowed?
- varnishadm
@@ -911,11 +910,11 @@ run from any cli: `curl -X PURGE https://yourwebsite.com/`.
- varnishstat
- varnishtest
- varnishtop
-4. How to reload Nginx?
-`docker exec Nginx nginx -t`
+4. How to reload Nginx?
+`docker exec Nginx nginx -t`
`docker exec Nginx nginx -s reload`
-
+
## Use Mongo
@@ -977,7 +976,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use PhpMyAdmin
1. Run the phpMyAdmin Container (`phpmyadmin`) with the `docker-compose up` command.
@@ -995,7 +994,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use Gitlab
1. Run the Gitlab Container (`gitlab`) with the `docker-compose up` command. Example:
@@ -1010,7 +1009,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use Gitlab Runner
1. Retrieve the registration token in your gitlab project (Settings > CI / CD > Runners > Set up a specific Runner manually)
@@ -1059,7 +1058,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use Adminer
@@ -1081,7 +1080,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use Portainer
1. Run the Portainer Container (`portainer`) with the `docker-compose up` command. Example:
@@ -1095,7 +1094,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use PgAdmin
1. Run the pgAdmin Container (`pgadmin`) with the `docker-compose up` command. Example:
@@ -1111,7 +1110,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use Beanstalkd
1. Run the Beanstalkd Container:
@@ -1139,7 +1138,7 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
-
+
## Use Confluence
@@ -1163,7 +1162,7 @@ You can set custom confluence version in `CONFLUENCE_VERSION`. [Find more info i
Keep in mind that Confluence is still accessible on 8090 anyway.
-
+
## Use ElasticSearch
@@ -1189,7 +1188,7 @@ docker-compose up -d elasticsearch
```
-
+
## Use MeiliSearch
@@ -1205,7 +1204,7 @@ docker-compose up -d meilisearch
-
+
## Use Selenium
1. Run the Selenium Container (`selenium`) with the `docker-compose up` command. Example:
@@ -1219,7 +1218,7 @@ docker-compose up -d meilisearch
-
+
## Use RethinkDB
@@ -1262,7 +1261,7 @@ A package ([Laravel RethinkDB](https://github.com/duxet/laravel-rethinkdb)) is b
- You may do backing up of your data using the next reference: [backing up your data](https://www.rethinkdb.com/docs/backup/).
-
+
## Use Minio
@@ -1309,7 +1308,7 @@ A package ([Laravel RethinkDB](https://github.com/duxet/laravel-rethinkdb)) is b
-
+
## Use Thumbor
@@ -1330,7 +1329,7 @@ docker-compose up -d thumbor
For more documentation on Thumbor visit the [Thumbor documenation](http://thumbor.readthedocs.io/en/latest/index.html) page
-
+
## Use AWS
@@ -1352,7 +1351,7 @@ docker-compose up -d aws
-
+
## Use Grafana
@@ -1373,7 +1372,7 @@ docker-compose up -d grafana
-
+
## Use Graylog
@@ -1403,7 +1402,7 @@ GRAYLOG_SHA256_PASSWORD=b1cb6e31e172577918c9e7806c572b5ed8477d3f57aa737bee4b5b1d
-
+
## Use Traefik
@@ -1483,7 +1482,7 @@ nginx:
-
+
## Use Mosquitto (MQTT Broker)
@@ -1502,7 +1501,7 @@ docker-compose up -d mosquitto
5 - Publish: `mqtt pub -t 'test' -h localhost -p 9001 -C 'ws' -m 'Hello!'`
-
+
## Use Tarantool (+ Admin panel)
@@ -1529,7 +1528,7 @@ docker-compose exec tarantool console
7 - There you can operate with tarantool database ([official documentation](https://www.tarantool.io/en/doc/latest/) can be helpful).
-
+
## Use Keycloak
@@ -1547,7 +1546,7 @@ docker-compose up -d keycloak
- Password: `secret`
-
+
## Use Mailpit
@@ -1569,7 +1568,7 @@ MAIL_PASSWORD=null
-
+
@@ -1577,7 +1576,7 @@ MAIL_PASSWORD=null
-
+
## Install CodeIgniter
@@ -1594,7 +1593,7 @@ To install CodeIgniter 3 on Laradock all you have to do is the following simple
-
+
## Install Powerline
@@ -1609,7 +1608,7 @@ Powerline is required python
-
+
## Install Symfony
@@ -1628,7 +1627,7 @@ Powerline is required python
-
+
## Miscellaneous
@@ -1637,7 +1636,7 @@ Powerline is required python
-
+
## Change the timezone
@@ -1658,7 +1657,7 @@ We also recommend [setting the timezone in Laravel](http://www.camroncade.com/ma
-
+
## Add locales to PHP-FPM
@@ -1681,7 +1680,7 @@ Update the locale setting, default is `POSIX`
3 - Check the default locale with `docker-compose exec php-fpm locale`
-
+
## Adding cron jobs
@@ -1703,7 +1702,7 @@ If you are on Windows, verify that the line endings for this file are LF only, o
-
+
## Access workspace via ssh
@@ -1736,7 +1735,7 @@ To login as root, replace laradock@localhost with root@localhost.
-
+
## Change the (MySQL) Version
By default **MySQL 8.0** is running.
@@ -1756,7 +1755,7 @@ Available versions are: 5.5, 5.6, 5.7, 8.0, or latest. See https://store.docker
-
+
## MySQL root access
@@ -1775,7 +1774,7 @@ The default username and password for the root MySQL user are `root` and `root `
-
+
## Create Multiple Databases
@@ -1793,7 +1792,7 @@ GRANT ALL ON `your_db_1`.* TO 'mysql_user'@'%' ;
-
+
## Change MySQL port
@@ -1811,7 +1810,7 @@ If you need MySQL access from your host , d
-
+
## Use custom Domain
@@ -1839,7 +1838,7 @@ server_name laravel.test;
-
+
## Global Composer Build Install
@@ -1858,7 +1857,7 @@ Enabling Global Composer Install during the build for the container allows you t
-
+
## Add authentication for Magento
@@ -1877,7 +1876,7 @@ Enabling Global Composer Install during the build for the container allows you t
-
+
## Install Prestissimo
@@ -1900,7 +1899,7 @@ c - Re-build the Workspace Container `docker-compose build workspace`
-
+
## Install Node + NVM
@@ -1915,7 +1914,7 @@ To install NVM and NodeJS in the Workspace container
A `.npmrc` file is included in the `workspace` folder if you need to utilise this globally. This is copied automatically into the root and laradock user's folders on build.
-
+
## Install PNPM
@@ -1935,7 +1934,7 @@ More info here: https://pnpm.js.org/en/motivation
-
+
## Install Node + YARN
@@ -1952,7 +1951,7 @@ Yarn is a new package manager for JavaScript. It is so faster than npm, which yo
-
+
## Install NPM GULP toolkit
@@ -1970,7 +1969,7 @@ To install NPM GULP toolkit in the Workspace container
-
+
## Install NPM BOWER
@@ -1987,7 +1986,7 @@ To install NPM BOWER package manager in the Workspace container
-
+
## Install NPM VUE CLI
@@ -2007,7 +2006,7 @@ To install NPM VUE CLI in the Workspace container
-
+
## Install NPM ANGULAR CLI
@@ -2020,7 +2019,7 @@ To install NPM ANGULAR CLI in the Workspace container
3 - Re-build the container `docker-compose build workspace`
-
+
## Install npm-check-updates CLI
@@ -2034,7 +2033,7 @@ To install npm-check-updates CLI [here](https://www.npmjs.com/package/npm-check-
4 - Re-build the container `docker-compose build workspace`
-
+
## Install `poppler-utils` (and `antiword` combined)
@@ -2073,7 +2072,7 @@ To install `poppler-utils` [(more here)](https://packages.debian.org/sid/poppler
-
+
## Install Linuxbrew
@@ -2089,7 +2088,7 @@ Linuxbrew is a package manager for Linux. It is the Linux version of MacOS Homeb
-
+
## Install FFMPEG
@@ -2106,7 +2105,7 @@ To install FFMPEG in the Workspace container
**PS** Don't forget to install the binary in the `php-fpm` container too by applying the same steps above to its container, otherwise you'll get an error when running the `php-ffmpeg` binary.
-
+
## Install BBC Audio Waveform Image Generator
@@ -2127,7 +2126,7 @@ To install BBC Audio Waveform Image Generator in the Workspace container
**PS** Don't forget to install the binary in the `php-fpm` container too by applying the same steps above to its container, otherwise you'll get an error when running the `audiowaveform` binary.
-
+
## Install wkhtmltopdf
@@ -2145,7 +2144,7 @@ To install wkhtmltopdf in the Workspace container
-
+
## Install GNU Parallel
@@ -2166,7 +2165,7 @@ To install GNU Parallel in the Workspace container
-
+
## Install Supervisor
@@ -2189,9 +2188,9 @@ To install Supervisor in the Workspace container
-
+
-
+
## Common Terminal Aliases
When you start your docker container, Laradock will copy the `aliases.sh` file located in the `laradock/workspace` directory and add sourcing to the container `~/.bashrc` file.
@@ -2202,22 +2201,22 @@ You are free to modify the `aliases.sh` as you see fit, adding your own aliases
-
+
## Install Aerospike extension
1 - First install `aerospike` in the Workspace and the PHP-FPM Containers:
-
+
a) open the `.env` file
-
+
b) search for the `WORKSPACE_INSTALL_AEROSPIKE` argument under the Workspace Container
-
+
c) set it to `true`
-
+
d) search for the `PHP_FPM_INSTALL_AEROSPIKE` argument under the PHP-FPM Container
-
+
e) set it to `true`
-
+
2 - Re-build the containers `docker-compose build workspace php-fpm`
@@ -2226,18 +2225,18 @@ e) set it to `true`
-
+
## Install Laravel Envoy
> A Tasks Runner.
1 - Open the `.env` file
-
+
2 - Search for the `WORKSPACE_INSTALL_LARAVEL_ENVOY` argument under the Workspace Container
-
+
3 - Set it to `true`
-
+
4 - Re-build the containers `docker-compose build workspace`
@@ -2250,18 +2249,18 @@ e) set it to `true`
## Install php calendar extension
1 - Open the `.env` file
-
+
2 - Search for the `PHP_FPM_INSTALL_CALENDAR` argument under the PHP-FPM container
-
+
3 - Set it to `true`
-
+
4 - Re-build the containers `docker-compose build php-fpm`
-
+
-
+
## Install libfaketime in php-fpm
@@ -2272,64 +2271,64 @@ For example:
will set the clock back 1 day. See (https://github.com/wolfcw/libfaketime) for more information.
1 - Open the `.env` file
-
+
2 - Search for the `PHP_FPM_INSTALL_FAKETIME` argument under the PHP-FPM container
-
+
3 - Set it to `true`
-
+
4 - Search for the `PHP_FPM_FAKETIME` argument under the PHP-FPM container
-
+
5 - Set it to the desired string
-
-6 - Re-build the containers `docker-compose build php-fpm`
+
+6 - Re-build the containers `docker-compose build php-fpm`
-
+
## Install YAML extension in php-fpm
YAML PHP extension allows you to easily parse and create YAML structured data. I like YAML because it's well readable for humans. See http://php.net/manual/en/ref.yaml.php and http://yaml.org/ for more info.
1 - Open the `.env` file
-
+
2 - Search for the `PHP_FPM_INSTALL_YAML` argument under the PHP-FPM container
-
+
3 - Set it to `true`
-
-4 - Re-build the container `docker-compose build php-fpm`
+
+4 - Re-build the container `docker-compose build php-fpm`
-
+
## Install RDKAFKA extension in php-fpm
1 - Open the `.env` file
-
+
2 - Search for the `PHP_FPM_INSTALL_RDKAFKA` argument under the PHP-FPM container
-
+
3 - Set it to `true`
-
-4 - Re-build the container `docker-compose build php-fpm`
+
+4 - Re-build the container `docker-compose build php-fpm`
-
+
## Install RDKAFKA extension in workspace
This is needed for 'composer install' if your dependencies require Kafka.
1 - Open the `.env` file
-
+
2 - Search for the `WORKSPACE_INSTALL_RDKAFKA` argument under the WORKSPACE container
-
+
3 - Set it to `true`
-
-4 - Re-build the container `docker-compose build workspace`
+
+4 - Re-build the container `docker-compose build workspace`
-
+
## Install AST PHP extension
AST exposes the abstract syntax tree generated by PHP 7+. This extension is required by tools such as `Phan`, a static analyzer for PHP.
@@ -2345,7 +2344,7 @@ AST exposes the abstract syntax tree generated by PHP 7+. This extension is requ
**Note** If you need a specific version of AST then search for the `WORKSPACE_AST_VERSION` argument under the Workspace Container and set it to the desired version and continue step 4.
-
+
## Install PHP Decimal extension
The PHP Decimal extension adds support for correctly-rounded, arbitrary-precision decimal floating point arithmetic. Applications that rely on accurate numbers (ie. money, measurements, or mathematics) can use Decimal instead of float or string to represent numerical values.
@@ -2361,7 +2360,7 @@ For more information visit the [PHP Decimal website](https://php-decimal.io).
4 - Re-build the container `docker-compose build workspace php-fpm`
-
+
## Install Git Bash Prompt
A bash prompt that displays information about the current git repository. In particular the branch name, difference with remote branch, number of files staged, changed, etc.
@@ -2377,29 +2376,29 @@ A bash prompt that displays information about the current git repository. In par
**Note** You can configure bash-git-prompt by editing the `workspace/gitprompt.sh` file and re-building the workspace container.
For configuration information, visit the [bash-git-prompt repository](https://github.com/magicmonty/bash-git-prompt).
-
+
## Install Oh My ZSH
-
+
## Install Dnsutils
1 - First install `dnsutils` in the Workspace and the PHP-FPM Containers:
-
+
a) open the `.env` file
-
+
b) search for the `WORKSPACE_INSTALL_DNSUTILS` argument under the Workspace Container
-
+
c) set it to `true`
-
+
d) search for the `PHP_FPM_INSTALL_DNSUTILS` argument under the PHP-FPM Container
-
+
e) set it to `true`
-
+
2 - Re-build the containers `docker-compose build workspace php-fpm`
@@ -2446,16 +2445,9 @@ Laradock provides aliases through the `aliases.sh` file located in the `laradock
3 - Rebuild and enjoy aliases
-
-
-## PHPStorm Debugging Guide
-Remote debug Laravel web and phpunit tests.
-
-[**Debugging Guide Here**](/guides/#PHPStorm-Debugging)
-
-
+
## Setup Google Cloud
@@ -2473,7 +2465,7 @@ gcloud auth login
-
+
## Track your Laradock changes
@@ -2491,7 +2483,7 @@ gcloud auth login
-
+
## Improve speed on MacOS
@@ -2522,7 +2514,7 @@ Quick Setup giude, (we recommend you check their docs)
-
+
### Workaround B: using d4m-nfs
@@ -2611,7 +2603,7 @@ Visit the [docker-sync documentation](https://github.com/EugenMayer/docker-sync/
-
+
### B.2: using the d4m-nfs tool
@@ -2653,7 +2645,7 @@ docker-compose up ...
*Note: If you faced any errors, try restarting Docker, and make sure you have no spaces in the `d4m-nfs-mounts.txt` file, and your `/etc/exports` file is clear.*
-
+
## ca-certificates
@@ -2661,7 +2653,7 @@ To install your own CA certificates, you can add them to the `workspace/ca-certi
This way the certificates will be installed into the system ca store of the workspace container.
-
+
## Upgrade Laradock
diff --git a/DOCUMENTATION/docusaurus.config.ts b/DOCUMENTATION/docusaurus.config.ts
new file mode 100644
index 0000000000..42be2fd4e1
--- /dev/null
+++ b/DOCUMENTATION/docusaurus.config.ts
@@ -0,0 +1,140 @@
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+
+const config: Config = {
+ title: 'Laradock',
+ tagline: 'Full PHP development environment on Docker.',
+ favicon: 'laradock.ico',
+
+ // Set the production url of your site here
+ url: 'https://laradock.io/',
+ // Set the // pathname under which your site is served
+ // For GitHub pages deployment, it is often '//'
+ baseUrl: '/',
+
+ // GitHub pages deployment config.
+ // If you aren't using GitHub pages, you don't need these.
+ organizationName: 'laradock/laradock', // Usually your GitHub org/user name.
+ projectName: 'laradock', // Usually your repo name.
+
+ onBrokenLinks: 'throw',
+ onBrokenMarkdownLinks: 'warn',
+
+ // Even if you don't use internationalization, you can use this field to set
+ // useful metadata like html lang. For example, if your site is Chinese, you
+ // may want to replace "en" with "zh-Hans".
+ i18n: {
+ defaultLocale: 'en',
+ locales: ['en'],
+ },
+
+ presets: [
+ [
+ '@docusaurus/preset-classic',
+ {
+ docs: {
+ id: 'default',
+ sidebarPath: './sidebars.ts',
+ // Please change this to your repo.
+ // Remove this to remove the "edit this page" links.
+ editUrl:
+ 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+ },
+ // blog: {
+ // showReadingTime: true,
+ // // Please change this to your repo.
+ // // Remove this to remove the "edit this page" links.
+ // editUrl:
+ // 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+ // },
+ theme: {
+ customCss: './src/css/custom.css',
+ },
+ gtag: {
+ trackingID: 'G-CVZBKZ36Y5', // Update with your Google Analytics ID
+ anonymizeIP: true,
+ },
+ } satisfies Preset.Options,
+ ],
+ ],
+
+ themeConfig: {
+ image: '/img/laradock/laradock-logo.jpg',
+ navbar: {
+ title: 'Laradock',
+ logo: {
+ alt: 'Laradock Logo',
+ src: '/img/laradock/laradock-icon.png',
+ },
+ items: [
+ // {
+ // type: 'docSidebar',
+ // sidebarId: 'tutorialSidebar',
+ // position: 'left',
+ // label: 'Tutorial',
+ // },
+ // {to: '/blog', label: 'Blog', position: 'left'},
+ {
+ href: 'https://github.com/laradock/laradock',
+ label: 'GitHub',
+ position: 'right',
+ },
+ ],
+ },
+ footer: {
+ style: 'dark',
+ links: [
+ // {
+ // title: 'Docs',
+ // items: [
+ // {
+ // label: 'Tutorial',
+ // to: '/docs/intro',
+ // },
+ // ],
+ // },
+ // {
+ // title: 'Community',
+ // items: [
+ // {
+ // label: 'Stack Overflow',
+ // href: 'https://stackoverflow.com/questions/tagged/docusaurus',
+ // },
+ // {
+ // label: 'Discord',
+ // href: 'https://discordapp.com/invite/docusaurus',
+ // },
+ // {
+ // label: 'Twitter',
+ // href: 'https://twitter.com/docusaurus',
+ // },
+ // ],
+ // },
+ // {
+ // title: 'More',
+ // items: [
+ // {
+ // label: 'Blog',
+ // to: '/blog',
+ // },
+ // {
+ // label: 'GitHub',
+ // href: 'https://github.com/Mahmoudz/Porto',
+ // },
+ // ],
+ // },
+ ],
+ copyright: `Copyright © 2016 - ${new Date().getFullYear()} - Laradock - By Mahmoud Zalt .`,
+ },
+ prism: {
+ theme: prismThemes.github,
+ darkTheme: prismThemes.dracula,
+ },
+ colorMode: {
+ defaultMode: 'dark',
+ },
+ } satisfies Preset.ThemeConfig,
+};
+
+export default config;
diff --git a/DOCUMENTATION/package.json b/DOCUMENTATION/package.json
new file mode 100644
index 0000000000..15384a5848
--- /dev/null
+++ b/DOCUMENTATION/package.json
@@ -0,0 +1,49 @@
+{
+ "name": "laradock-documentation",
+ "version": "1.0.0",
+ "private": false,
+ "scripts": {
+ "start": "docusaurus start",
+ "deploy": "docusaurus build && gh-pages -d build",
+ "docusaurus": "docusaurus",
+ "build": "docusaurus build",
+ "swizzle": "docusaurus swizzle",
+ "clear": "docusaurus clear",
+ "serve": "docusaurus serve",
+ "write-translations": "docusaurus write-translations",
+ "write-heading-ids": "docusaurus write-heading-ids",
+ "typecheck": "tsc"
+ },
+ "dependencies": {
+ "@docusaurus/core": "3.3.0",
+ "@docusaurus/preset-classic": "3.3.0",
+ "@mdx-js/react": "^3.0.0",
+ "@sista/ai-assistant-react": "^2.2.0",
+ "clsx": "^2.0.0",
+ "prism-react-renderer": "^2.3.0",
+ "react": "^18.0.0",
+ "react-dom": "^18.0.0"
+ },
+ "devDependencies": {
+ "@docusaurus/module-type-aliases": "3.3.0",
+ "@docusaurus/tsconfig": "3.3.0",
+ "@docusaurus/types": "3.3.0",
+ "gh-pages": "^6.1.1",
+ "typescript": "~5.2.2"
+ },
+ "browserslist": {
+ "production": [
+ ">0.5%",
+ "not dead",
+ "not op_mini all"
+ ],
+ "development": [
+ "last 3 chrome version",
+ "last 3 firefox version",
+ "last 5 safari version"
+ ]
+ },
+ "engines": {
+ "node": ">=18.0"
+ }
+}
diff --git a/DOCUMENTATION/sidebars.ts b/DOCUMENTATION/sidebars.ts
new file mode 100644
index 0000000000..acc7685acd
--- /dev/null
+++ b/DOCUMENTATION/sidebars.ts
@@ -0,0 +1,31 @@
+import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+const sidebars: SidebarsConfig = {
+ // By default, Docusaurus generates a sidebar from the docs folder structure
+ tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+
+ // But you can create a sidebar manually
+ /*
+ tutorialSidebar: [
+ 'intro',
+ 'hello',
+ {
+ type: 'category',
+ label: 'Tutorial',
+ items: ['tutorial-basics/create-a-document'],
+ },
+ ],
+ */
+};
+
+export default sidebars;
diff --git a/DOCUMENTATION/src/components/AiAssistant/index.tsx b/DOCUMENTATION/src/components/AiAssistant/index.tsx
new file mode 100644
index 0000000000..d8f75f7da3
--- /dev/null
+++ b/DOCUMENTATION/src/components/AiAssistant/index.tsx
@@ -0,0 +1,121 @@
+import React, { useEffect } from "react";
+import { useHistory } from "react-router-dom";
+import { AiAssistantButton, useAiAssistant } from "@sista/ai-assistant-react";
+
+const AiAssistant = () => {
+ const { registerFunctions } = useAiAssistant();
+ const history = useHistory();
+
+ const navigateToPage = ({ page }) => {
+ history.push(`/${page}`);
+ };
+
+ const navigateToExternalUrl = ({ url }) => {
+ window.location.href = url;
+ };
+
+ const goToNextPage = () => {
+ const nextPageButton = document.querySelector(
+ "a.pagination-nav__link.pagination-nav__link--next"
+ ) as HTMLElement;
+ if (nextPageButton) {
+ nextPageButton.click();
+ }
+ };
+
+ const goToPreviousPage = () => {
+ const previousPageButton = document.querySelector(
+ "a.pagination-nav__link.pagination-nav__link--prev"
+ ) as HTMLElement;
+ if (previousPageButton) {
+ previousPageButton.click();
+ }
+ };
+
+ const switchTheme = () => {
+ const themeToggle = document.querySelector(
+ 'button[title^="Switch between dark and light mode"][class*="ColorModeToggle-styles-module"]'
+ ) as HTMLElement;
+ if (themeToggle) {
+ themeToggle.click();
+ }
+ };
+
+ useEffect(() => {
+ const aiFunctions = [
+ {
+ function: {
+ handler: navigateToPage,
+ description:
+ "Go to a specific page. Navigate to a page. Internal pages. This is what the user often wants, when asking for navigation. Each page contains info about the specific topic, as you can tell from the page name.",
+ parameters: {
+ type: "object",
+ properties: {
+ page: {
+ type: "string",
+ description: "The page to navigate to.",
+ enum: [
+ "/?page=home",
+ "docs/intro/",
+
+ "docs/getting-started",
+ "docs/usage",
+ "docs/help",
+ "docs/related-projects",
+ "docs/contributing",
+ ],
+ },
+ },
+ required: ["page"],
+ },
+ },
+ },
+ {
+ function: {
+ handler: navigateToExternalUrl,
+ description: "Navigate to an external URL.",
+ parameters: {
+ type: "object",
+ properties: {
+ url: {
+ type: "string",
+ description:
+ "The URL to navigate to. For 'Github' go to 'https://github.com/laradock/laradock'. For 'Sista' go to 'https://smart.sista.ai/?utm_source=docs_laradock&utm_medium=ai_assistant&utm_campaign=user_request_for_navigation'.",
+ },
+ },
+ required: ["url"],
+ },
+ },
+ },
+ {
+ function: {
+ handler: goToNextPage,
+ description:
+ "Navigate to the next page. Go to the next page. Click on the next page. Next. Next Page.",
+ },
+ },
+ {
+ function: {
+ handler: goToPreviousPage,
+ description:
+ "Navigate to the previous page. Go to the previous page. Click on the previous page. Previous. Previous Page.",
+ },
+ },
+ {
+ function: {
+ handler: switchTheme,
+ description:
+ "Turn On / Off the light. Change theme color. Switches between dark and light modes. Toggle the theme.",
+ },
+ },
+ ];
+
+ if (registerFunctions) {
+ registerFunctions(aiFunctions);
+ }
+ }, [registerFunctions]);
+
+ return ;
+};
+
+export default AiAssistant;
diff --git a/DOCUMENTATION/src/components/SponsorsPage/index.tsx b/DOCUMENTATION/src/components/SponsorsPage/index.tsx
new file mode 100644
index 0000000000..9d039e9e15
--- /dev/null
+++ b/DOCUMENTATION/src/components/SponsorsPage/index.tsx
@@ -0,0 +1,51 @@
+import clsx from "clsx";
+import Heading from "@theme/Heading";
+import sponsorsStyles from "./styles.module.css";
+
+type SponsorItem = {
+ link: string;
+ imageUrl: string;
+ description: JSX.Element;
+};
+
+const SponsorList: SponsorItem[] = [
+ {
+ link: "https://smart.sista.ai/?utm_source=docs_laradock&utm_medium=sponsor&utm_campaign=landing_page_welcome",
+ imageUrl: "/img/sponsors/sista-ai-logo.png",
+ description: (
+ <>
+ Make Your Apps Smarter with a Plug-and-Play AI Voice Assistant.
+ >
+ ),
+ },
+];
+
+function Sponsor({ link, imageUrl, description }: SponsorItem) {
+ return (
+
+ );
+}
+
+export default function SponsorsPage(): JSX.Element {
+ return (
+
+
+
+ {SponsorList.map((props, idx) => (
+
+ ))}
+
+
+
+ );
+}
diff --git a/DOCUMENTATION/src/components/SponsorsPage/styles.module.css b/DOCUMENTATION/src/components/SponsorsPage/styles.module.css
new file mode 100644
index 0000000000..444df96a68
--- /dev/null
+++ b/DOCUMENTATION/src/components/SponsorsPage/styles.module.css
@@ -0,0 +1,10 @@
+.sponsors {
+ display: flex;
+ align-items: center;
+ padding: 2rem 0;
+ width: 100%;
+}
+
+.sponsorImg {
+ width: 35%;
+}
diff --git a/DOCUMENTATION/src/components/WelcomePage/index.tsx b/DOCUMENTATION/src/components/WelcomePage/index.tsx
new file mode 100644
index 0000000000..0de0b90381
--- /dev/null
+++ b/DOCUMENTATION/src/components/WelcomePage/index.tsx
@@ -0,0 +1,10 @@
+import React from 'react';
+import styles from './styles.module.css';
+
+export default function WelcomePage() {
+ return (
+
+ Fully Dockerized PHP Environment, Ready to Go!
+
+ );
+}
diff --git a/DOCUMENTATION/src/components/WelcomePage/styles.module.css b/DOCUMENTATION/src/components/WelcomePage/styles.module.css
new file mode 100644
index 0000000000..4b2de24045
--- /dev/null
+++ b/DOCUMENTATION/src/components/WelcomePage/styles.module.css
@@ -0,0 +1,22 @@
+.welcome {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ height: 70vh;
+ background-image: url("/img/laradock/laradock-abstract.jpg");
+ background-size: 100%;
+ /* background-position: center 40%; */
+ color: white;
+ text-align: center;
+}
+.welcome h1 {
+ font-size: 3.5rem;
+ color: #242526;
+ font-weight: 800;
+ text-shadow: 2px 4px 8px rgba(255, 255, 255, 0.8);
+ margin: 0;
+ padding: 0 20px;
+ letter-spacing: 2px;
+ line-height: 1.1;
+ transition: transform 0.3s ease-in-out;
+}
diff --git a/DOCUMENTATION/src/config.json b/DOCUMENTATION/src/config.json
new file mode 100644
index 0000000000..ff87da5f0b
--- /dev/null
+++ b/DOCUMENTATION/src/config.json
@@ -0,0 +1,4 @@
+{
+ "SISTA_AI_API_KEY": "pk-sista-b4035cb0-39ae-4332-b0c1-5f52b2d5c716",
+ "SISTA_AI_API_KEY_DEV": "pk-sista-b4035cb0-39ae-4332-b0c1-5f52b2d5c716"
+}
diff --git a/DOCUMENTATION/src/css/custom.css b/DOCUMENTATION/src/css/custom.css
new file mode 100644
index 0000000000..3cc3670a14
--- /dev/null
+++ b/DOCUMENTATION/src/css/custom.css
@@ -0,0 +1,30 @@
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+:root {
+ --ifm-color-primary: #996ee1;
+ --ifm-color-primary-dark: #724EB5;
+ --ifm-color-primary-darker: #6745A8;
+ --ifm-color-primary-darkest: #5C3C9B;
+ --ifm-color-primary-light: #8A63CF;
+ --ifm-color-primary-lighter: #9770DC;
+ --ifm-color-primary-lightest: #A47DE9;
+ --ifm-code-font-size: 95%;
+ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+}
+
+/* For readability concerns, you should choose a lighter palette in dark mode. */
+[data-theme='dark'] {
+ --ifm-color-primary: #FAAE19;
+ --ifm-color-primary-dark: #E09D17;
+ --ifm-color-primary-darker: #C68C15;
+ --ifm-color-primary-darkest: #AC7B13;
+ --ifm-color-primary-light: #FBB43D;
+ --ifm-color-primary-lighter: #FCC961;
+ --ifm-color-primary-lightest: #FDDC85;
+ --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+}
diff --git a/DOCUMENTATION/src/pages/index.module.css b/DOCUMENTATION/src/pages/index.module.css
new file mode 100644
index 0000000000..db91e6ea25
--- /dev/null
+++ b/DOCUMENTATION/src/pages/index.module.css
@@ -0,0 +1,33 @@
+/**
+ * CSS files with the .module.css suffix will be treated as CSS modules
+ * and scoped locally.
+ */
+
+.heroBanner {
+ padding: 7rem 0;
+ text-align: left;
+ position: relative;
+ overflow: hidden;
+}
+
+@media screen and (max-width: 996px) {
+ .heroBanner {
+ padding: 2rem;
+ }
+}
+
+.buttons {
+ display: flex;
+ align-items: left;
+ justify-content: left;
+}
+.bigColorfulButton {
+ font-size: 2.2rem;
+ background-color: var(--ifm-color-primary);
+ color: white;
+ font-weight: normal;
+}
+
+.bigColorfulButton:hover {
+ color: rgba(255, 255, 255, 0.739);
+}
diff --git a/DOCUMENTATION/src/pages/index.tsx b/DOCUMENTATION/src/pages/index.tsx
new file mode 100644
index 0000000000..313410a94b
--- /dev/null
+++ b/DOCUMENTATION/src/pages/index.tsx
@@ -0,0 +1,58 @@
+import clsx from "clsx";
+import Link from "@docusaurus/Link";
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import Layout from "@theme/Layout";
+import Heading from "@theme/Heading";
+import useBaseUrl from "@docusaurus/useBaseUrl";
+import styles from "./index.module.css";
+import WelcomePage from "../components/WelcomePage";
+import SponsorsPage from "../components/SponsorsPage";
+
+function HomepageHeader() {
+ const { siteConfig } = useDocusaurusContext();
+ const headerImage = useBaseUrl("/img/laradock/laradock-icon.png");
+
+ return (
+
+
+
+ {siteConfig.title}
+
+
{siteConfig.tagline}
+
+
+ Get Started
+
+
+
+
+ );
+}
+export default function Home(): JSX.Element {
+ const { siteConfig } = useDocusaurusContext();
+ return (
+
+
+
+
+
+
+
+
+
+ );
+}
diff --git a/DOCUMENTATION/src/pages/markdown-page.md b/DOCUMENTATION/src/pages/markdown-page.md
new file mode 100644
index 0000000000..2c8c82ade0
--- /dev/null
+++ b/DOCUMENTATION/src/pages/markdown-page.md
@@ -0,0 +1,7 @@
+---
+title: Porto SAP PAGE
+---
+
+# Porto SAP
+
+Welcome to the future
diff --git a/DOCUMENTATION/src/theme/Layout.tsx b/DOCUMENTATION/src/theme/Layout.tsx
new file mode 100644
index 0000000000..c8e6e97811
--- /dev/null
+++ b/DOCUMENTATION/src/theme/Layout.tsx
@@ -0,0 +1,29 @@
+import React from "react";
+import OriginalLayout from "@theme-original/Layout";
+import AiAssistant from "../components/AiAssistant";
+import { AiAssistantProvider } from "@sista/ai-assistant-react";
+const config = require("../config");
+
+const Layout = (props) => {
+ return (
+
+ {props.children}
+
+
+ );
+};
+
+const Providers = (props) => {
+ return (
+
+
+
+ );
+};
+
+export default Providers;
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/404.html b/DOCUMENTATION/static/.nojekyll
similarity index 100%
rename from DOCUMENTATION/themes/hugo-material-docs/layouts/404.html
rename to DOCUMENTATION/static/.nojekyll
diff --git a/DOCUMENTATION/static/ads.txt b/DOCUMENTATION/static/ads.txt
deleted file mode 100644
index 2230196568..0000000000
--- a/DOCUMENTATION/static/ads.txt
+++ /dev/null
@@ -1 +0,0 @@
-google.com, pub-9826129398689742, DIRECT, f08c47fec0942fa0
diff --git a/DOCUMENTATION/static/custom-style.css b/DOCUMENTATION/static/custom-style.css
deleted file mode 100644
index 6e20a8dd3c..0000000000
--- a/DOCUMENTATION/static/custom-style.css
+++ /dev/null
@@ -1,32 +0,0 @@
-/* Custom CSS */
-.article{
- overflow-x:hidden;
-}
-.article a {
- border-bottom: none;
-}
-.project .logo {
- width: 200px;
- padding-right: 0;
-}
-.project .banner {
- height: 70px;
- padding: 25px;
-}
-.palette-primary-deep-purple .article h1{
- color: #7e57c2;
- font-size: 35px;
-}
-.palette-primary-deep-purple .article h2{
-
- color: #ce2046;
- font-size: 25px;
-}
-.palette-primary-deep-purple .article h3{
- color: #851d54;
- font-size: 18px;
-}
-.palette-primary-deep-purple .article code{
- color: #851d54;
- background: #eeeeeea8;
-}
diff --git a/DOCUMENTATION/static/img/laradock/laradock-abstract.jpg b/DOCUMENTATION/static/img/laradock/laradock-abstract.jpg
new file mode 100644
index 0000000000..9bd0f19755
Binary files /dev/null and b/DOCUMENTATION/static/img/laradock/laradock-abstract.jpg differ
diff --git a/DOCUMENTATION/themes/hugo-material-docs/static/images/logo.png b/DOCUMENTATION/static/img/laradock/laradock-icon.png
similarity index 100%
rename from DOCUMENTATION/themes/hugo-material-docs/static/images/logo.png
rename to DOCUMENTATION/static/img/laradock/laradock-icon.png
diff --git a/DOCUMENTATION/themes/hugo-material-docs/static/images/laradock-full-logo.jpg b/DOCUMENTATION/static/img/laradock/laradock-logo.jpg
similarity index 100%
rename from DOCUMENTATION/themes/hugo-material-docs/static/images/laradock-full-logo.jpg
rename to DOCUMENTATION/static/img/laradock/laradock-logo.jpg
diff --git a/DOCUMENTATION/static/img/sponsors/sista-ai-logo.png b/DOCUMENTATION/static/img/sponsors/sista-ai-logo.png
new file mode 100644
index 0000000000..46655db63a
Binary files /dev/null and b/DOCUMENTATION/static/img/sponsors/sista-ai-logo.png differ
diff --git a/DOCUMENTATION/static/laradock.ico b/DOCUMENTATION/static/laradock.ico
new file mode 100644
index 0000000000..38b1068ae0
Binary files /dev/null and b/DOCUMENTATION/static/laradock.ico differ
diff --git a/DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md b/DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md
deleted file mode 100644
index 04cec42d1d..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/CHANGELOG.md
+++ /dev/null
@@ -1,29 +0,0 @@
-# Changelog
-
-
-### 11th May 2016
-
-#### Add templates for section lists
-
-Sections such as www.example.com/foo/ will now be rendered with a list of all pages that are part of this section. The list shows the pages' title and a summary of their content.
-
-[Show me the diff](https://github.com/digitalcraftsman/hugo-material-docs/commit/1f8393a8d4ce1b8ee3fc7d87be05895c12810494)
-
-### 22nd March 2016
-
-#### Changing setup for Google Analytics
-
-Formerly, the tracking id for Google Analytics was set like below:
-
-```toml
-[params]
- google_analytics = ["UA-XXXXXXXX-X", "auto"]
-```
-
-Now the theme uses Hugo's own Google Analytics config option. The variable moved outside the scope of `params` and the setup requires only the tracking id as a string:
-
-```toml
-googleAnalytics = "UA-XXXXXXXX-X"
-```
-
-[Show me the diff](https://github.com/digitalcraftsman/hugo-material-docs/commit/fa10c8eef935932426d46b662a51f29a5e0d48e2)
\ No newline at end of file
diff --git a/DOCUMENTATION/themes/hugo-material-docs/LICENSE.md b/DOCUMENTATION/themes/hugo-material-docs/LICENSE.md
deleted file mode 100644
index 1a5879b3b9..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/LICENSE.md
+++ /dev/null
@@ -1,20 +0,0 @@
-Copyright (c) 2016 Digitalcraftsman
-Copyright (c) 2016 Martin Donath
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to
-deal in the Software without restriction, including without limitation the
-rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-sell copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-IN THE SOFTWARE.
\ No newline at end of file
diff --git a/DOCUMENTATION/themes/hugo-material-docs/README.md b/DOCUMENTATION/themes/hugo-material-docs/README.md
deleted file mode 100644
index efcc807de3..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/README.md
+++ /dev/null
@@ -1,40 +0,0 @@
-# Material Docs
-
-A material design theme for [Hugo](https://gohugo.io).
-
-[![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-material-docs/master/static/images/screen.png)](https://digitalcraftsman.github.io/hugo-material-docs/)
-
-## Quick start
-
-Install with `git`:
-
-
- git clone https://github.com/digitalcraftsman/hugo-material-docs.git themes/hugo-material-docs
-
-
-Next, take a look in the `exampleSite` folder at. This directory contains an example config file and the content for the demo. It serves as an example setup for your documentation.
-
-Copy at least the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
-
-Hugo includes a development server, so you can view your changes as you go -
-very handy. Spin it up with the following command:
-
-``` sh
-hugo server
-```
-
-Now you can go to [localhost:1313](http://localhost:1313) and the Material
-theme should be visible. For detailed installation instructions visit the [demo](http://themes.gohugo.io/theme/material-docs/).
-
-Noteworthy changes of this theme are listed in the [changelog](https://github.com/digitalcraftsman/hugo-material-docs/blob/master/CHANGELOG.md).
-
-## Acknowledgements
-
-A big thank you to [Martin Donath](https://github.com/squidfunk). He created the original [Material theme](https://github.com/squidfunk/mkdocs-material) for Hugo's companion [MkDocs](http://www.mkdocs.org/). This port wouldn't be possible without him.
-
-Furthermore, thanks to [Steve Francia](https://gihub.com/spf13) for creating Hugo and the [awesome community](https://github.com/spf13/hugo/graphs/contributors) around the project.
-
-## License
-
-The theme is released under the MIT license. Read the [license](https://github.com/digitalcraftsman/hugo-material-docs/blob/master/LICENSE.md) for more information.
-
diff --git a/DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md b/DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md
deleted file mode 100644
index a49ba48448..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/archetypes/default.md
+++ /dev/null
@@ -1,2 +0,0 @@
----
----
\ No newline at end of file
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html
deleted file mode 100644
index fb1046a4aa..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/__list.html
+++ /dev/null
@@ -1,58 +0,0 @@
-{{ partial "head" . }}
-
-
-
-
-
-
-
-
-
-
-
- {{ partial "drawer" . }}
-
-
-
-
-
Pages in {{ .Title | singularize }}
-
- {{ range .Data.Pages }}
-
- {{ .Title }}
-
-
-
- {{ printf "%s" .Summary | markdownify }}
-
-
- {{ end }}
-
-
- {{ with .Site.Params.copyright }}
- © {{ $.Now.Format "2006" }} {{ . }} –
- {{ end }}
-
- Documentation built with
- Hugo
- using the
- Material theme.
-
-
-
-
-
-
-
-{{ partial "footer_js" . }}
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html
deleted file mode 100644
index 83cf3ee3b8..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/layouts/_default/single.html
+++ /dev/null
@@ -1,58 +0,0 @@
-{{ partial "head" . }}
-
-{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
- {{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
- {{ .Scratch.Set "repo_id" $repo_id }}
-{{ end }}
-
-
-
-
-
-
-
-
-
-
-
- {{ partial "drawer" . }}
-
-
-
-
-
{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}
-
- {{ .Content }}
-
-
- {{ with .Site.Params.copyright }}
- © {{ $.Now.Format "2006" }} {{ . }} –
- {{ end }}
-
- Documentation built with
- Hugo
- using the
- Material theme.
-
-
-
-
-
-
-
-
-
-{{ partial "footer_js" . }}
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html
deleted file mode 100644
index c09a68bfb7..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/layouts/index.html
+++ /dev/null
@@ -1,82 +0,0 @@
-{{ partial "head" . }}
-
-{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
- {{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
- {{ .Scratch.Set "repo_id" $repo_id }}
-{{ end }}
-
-
-
-
-
-
-
-
-
-
-
- {{ partial "drawer" . }}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- {{ range where .Site.Pages "Type" "index" }}
-
-
-
-
{{ .Title }} {{ if .IsDraft }} (Draft){{ end }}
-
- {{ .Content }}
- {{ end }}
-
-
- {{ with .Site.Params.copyright }}
- © {{ $.Now.Format "2006" }} {{ . }} –
- {{ end }}
-
- Documentation built with
- Hugo
- using the
- Material theme,
- by
- Mahmoud Zalt .
-
-
-
-
-
-
-
-
-
-{{ partial "footer_js" . }}
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/drawer.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/drawer.html
deleted file mode 100644
index 7fd69c9cad..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/drawer.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-
- {{ with .Site.Params.logo }}
-
-
-
-
- {{ end }}
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer.html
deleted file mode 100644
index c0017542f4..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer.html
+++ /dev/null
@@ -1,74 +0,0 @@
-{{ if .IsPage }}
-{{ if .Prev | or .Next }}
-
-{{ end }}
-{{ end }}
-
-{{ if .IsHome }}
-{{ if gt (len .Site.Pages) 2 }}
-
-{{ end }}
-{{ end }}
diff --git a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer_js.html b/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer_js.html
deleted file mode 100644
index 8b0b55e837..0000000000
--- a/DOCUMENTATION/themes/hugo-material-docs/layouts/partials/footer_js.html
+++ /dev/null
@@ -1,91 +0,0 @@
-
-
-
- {{ range .Site.Params.custom_js }}
-
- {{ end }}
-
-
-
- {{ with .Site.GoogleAnalytics }}
-
- {{ end }}
-
-
-
-