Introduction
This guide will show you how to install the Knowledge Base (KB) on your own server using Docker. This is useful for administrators who want to host KB locally for full control. By following these steps, you’ll be able to set up the environment and deploy the KB instance securely and efficiently.
Target Audience
- Administrator
Prerequisites
- Experience with Docker and Docker Compose
- Easy8 v13 installed with the blue_spice plugin
- A web server proxy (e.g. nginx or Apache)
- A prepared URL for the KB instance
- Access to the README.md installation manual (provided in the package)
- Credentials to the Docker registry (provided by Easy Support)
How to Install Knowledge Base On Premises
Step 1: Prepare Your Environment
- Install Docker (supported version)
- Install Docker Compose (supported version)
- Create a .env file for Docker Compose (use the example provided in your installation package)
- Ensure Easy8 v13 is installed and has the blue_spice plugin activated
- Set up a web server proxy (e.g. nginx, Apache) and configure the server for the KB instance URL
Step 2: Obtain Docker Image Access
- Easy Support will send you credentials to the Docker registry
- Enter these credentials into the respective Docker configuration file
Step 3: Deploy the KB Instance
- Run the command:
docker-compose up -d - The installation process will automatically:
- Download the Docker image
- Launch all required services
- Establish a secure handshake between Easy8 and the KB
Step 4: Updating the Instance
- To update KB later, run the same
docker-composecommand - The system will automatically replace the existing image with the latest version available in the registry
Troubleshooting
| Issue | Solution |
|---|---|
| Docker image not downloading | Check Docker registry credentials and internet access. |
| Secure handshake not working | Verify Easy8 v13 is installed and the blue_spice plugin is active. |
| Web server does not display KB | Ensure the URL and proxy configuration are correct and ports are open. |
Conclusion
You have successfully installed the Knowledge Base on your own server using Docker and Easy8. The process is automatic once you meet the prerequisites, and updates are as easy as re-running the Docker deployment.
Related Topics and Further Reading
- Easy8 Documentation
- Easy Project Documentation
- README.md included in your installation package
