diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..119c3990 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,8 @@ +FROM python:3.9 + +VOLUME [ "/docs" ] +WORKDIR /docs +CMD [ "mkdocs", "serve", "-a", "0.0.0.0:8000" ] + +ADD requirements.txt /tmp +RUN pip install -r /tmp/requirements.txt diff --git a/README.md b/README.md index 1dc6372f..caa372e6 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# docs \ No newline at end of file +# docs + +The documentation uses mkdocs to render the content. + +``` +# Install the requirements first +pip install -r requirements.txt + +# Start the mkdocs server in development mode +mkdocs serve +``` + +Alternatively you can use a docker container: + +``` +docker build . -t thehive-docs +docker run -it --rm -p 8000:8000 -v $PWD:/docs thehive-docs +``` diff --git a/docs/thehive/installation-and-configuration/installation/step-by-step-guide.md b/docs/thehive/installation-and-configuration/installation/step-by-step-guide.md index 85da0f5f..b2e589d1 100644 --- a/docs/thehive/installation-and-configuration/installation/step-by-step-guide.md +++ b/docs/thehive/installation-and-configuration/installation/step-by-step-guide.md @@ -583,6 +583,8 @@ service thehive start Please note that the service may take some time to start. Once it is started, you may launch your browser and connect to `http://YOUR_SERVER_ADDRESS:9000/`. +The default admin user is `admin@thehive.local` with password `secret`. It is recommended to change the default password. + ## Advanced configuration For additional configuration options, please refer to the [Configuration Guides](../index.md#configuration-guides).