diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 00000000..8c36936e Binary files /dev/null and b/.DS_Store differ diff --git a/.gitignore b/.gitignore index 1b0619f0..b4439f9d 100644 --- a/.gitignore +++ b/.gitignore @@ -132,3 +132,7 @@ http-client.private.env.json # All idea files .idea/** + +# Docs +docs/node_modules/ +docs/_site/ diff --git a/README.md b/README.md index f4fa4cae..5bd0be30 100644 --- a/README.md +++ b/README.md @@ -26,64 +26,7 @@ Zen operates autonomously on the same server as your PHP app to: ## Install -Zen for PHP comes as a single package that needs to be installed on the system to be protected. -Prerequisites: -* Ensure you have sudo privileges on your system. -* Check that you have a supported PHP version installed (PHP version >= 7.2 and tested up to 8.5). -* Make sure to use the appropriate commands for your system or cloud provider. - -### Manual install - -#### For Red Hat-based Systems (RHEL, CentOS, Fedora) - -##### x86_64 -``` -rpm -Uvh --oldpackage https://github.com/AikidoSec/firewall-php/releases/download/v1.4.11/aikido-php-firewall.x86_64.rpm -``` - -##### arm64 / aarch64 -``` -rpm -Uvh --oldpackage https://github.com/AikidoSec/firewall-php/releases/download/v1.4.11/aikido-php-firewall.aarch64.rpm -``` - -#### For Debian-based Systems (Debian, Ubuntu) - -##### x86_64 -``` -curl -L -O https://github.com/AikidoSec/firewall-php/releases/download/v1.4.11/aikido-php-firewall.x86_64.deb -dpkg -i -E ./aikido-php-firewall.x86_64.deb -``` - -##### arm64 / aarch64 -``` -curl -L -O https://github.com/AikidoSec/firewall-php/releases/download/v1.4.11/aikido-php-firewall.aarch64.deb -dpkg -i -E ./aikido-php-firewall.aarch64.deb -``` - -We support Debian >= 11 and Ubuntu >= 20.04. -You can run on Debian 10, by doing this setup before install: [Debian10 setup](./docs/debian10.md) - -#### Deployment setup -- [Caddy & PHP-FPM](./docs/caddy.md) -- [Apache mod_php](./docs/apache-mod-php.md) - -#### Managed platforms -- [Laravel Forge](./docs/laravel-forge.md) -- [AWS Elastic beanstalk](./docs/aws-elastic-beanstalk.md) -- [Fly.io](./docs/fly-io.md) - -#### Aikido Token setup -- The standard way of setting the Aikido Token is via environment variables -> `AIKIDO_TOKEN="your token"`. -- Another way of doing that, is adding the `AIKIDO_TOKEN` variable in your `.env` file. -- If you are unable to set any of the above, there's an alternative way of doing that from PHP, by following the ["Token setup from PHP code"](./docs/token-setup-php.md). - -### Troubleshooting - -[Read our troubleshooting documentation.](./docs/troubleshooting.md) - -> [!IMPORTANT] -> If you switch PHP versions after installing Zen, you will need to reinstall the firewall. See [Switching PHP versions](./docs/troubleshooting.md#switching-php-versions) in the troubleshooting documentation for detailed instructions. ## Supported libraries and frameworks diff --git a/docs/.DS_Store b/docs/.DS_Store new file mode 100644 index 00000000..c7a801ee Binary files /dev/null and b/docs/.DS_Store differ diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..6baa3386 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,12 @@ +--- + +--- +# README for building docs + +## Build and run locally + +``` +npm install +npm run watch +``` +Open http://localhost:8080/ diff --git a/docs/_includes/default.njk b/docs/_includes/default.njk new file mode 100644 index 00000000..0a206cdb --- /dev/null +++ b/docs/_includes/default.njk @@ -0,0 +1,71 @@ + + +
+ + +