Settings¶
.env file¶
You can customize the installation and startup scripts (e.g., system resources, service ports, etc.) through the .env file.
Tip
Customizing the .env file requires your docker compose version to be 2.17.0 or higher.
Assuming you followed the installation steps in the Quick Start guide, your directory structure should look like this:
.
|-- beatsight-docker-1.3.0-ce
| |-- README.md
| |-- backup.sh
| |-- backups
| |-- beatsight_install_log-2024-10-26_04-10-18.txt
| |-- docker-compose.yaml
| |-- install
| |-- install.sh
| |-- logs
| |-- runtime
| |-- start.sh
| `-- stop.sh
|-- license.json
|-- logs
| |-- beatsight
| |-- nginx
| `-- supervisor
`-- runtime
|-- beatsight.nginx.conf
|-- beatsight_settings.py
`-- gunicorn.conf.py
The beatsight-docker-1.3.0-ce/.env file contains several configurable parameters, such as:
BEATSIGHT_BIND=8999 # The port that the service is bound to.
BEATSIGHT_IMAGE=reg.beatsight.com/beatsight/beatsight:v1.3.0 # The current image version.
MIN_RAM_HARD=4000 # The minimum memory requirement for the system.
MIN_CPU_HARD=2 # The minimum CPU core requirement for the system.
You can create a .env file in the installation directory to override these parameters.
Service Port¶
Beatsight binds to port 8999 by default. If you need to change this, follow these steps:
Open the /opt/beatsight/.env file by running the following command:
After modifying the port to the appropriate value, save and exit the file. Then, restart the service to apply the changes.
System Resources¶
The installation script defaults to requiring 2 CPU cores and 4 GB of RAM for optimal performance. However, if your system does not meet these requirements, you can lower these parameters.
Open the /opt/beatsight/.env file by running the following command:
After making the necessary changes, simply re-run the ./install.sh script to apply the new configuration. This will ensure that the system is set up according to your adjusted resource settings.
Tip
If your system resources are too low, the system may experience instability. For production use, we recommend adhering to the official system resource requirements to ensure optimal performance and stability.
beatsight_settings.py¶
Domain¶
If your server's IP changes or you have configured a domain name, you need to configure the following two variables for the system to function correctly. The details are as follows:
Open runtime/beatsight_settings.py
Assuming your current Beatsight access address is: http://test.example.com:8999, you need to configure the following two variables:
# ALLOWED_HOSTS
ALLOWED_HOSTS = [
'test.example.com',
]
# CSRF_TRUSTED_ORIGINS
CSRF_TRUSTED_ORIGINS = [
'http://test.example.com:8999',
]
After saving and restarting the service, Beatsight will be able to correctly respond to requests from http://test.example.com:8999, ensuring that the CSRF protection mechanism remains effective.
Email Sending¶
Some features of Beatsight, such as password resets, rely on email sending services. To ensure these features work properly, you need to configure your email service. Here's how you can do it:
Open runtime/beatsight_settings.py
Navigate to the Email settings section, where you will find configuration options like the following:
# Email settings
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = 'smtp.mail.com'
EMAIL_PORT = 587
EMAIL_USE_TLS = True # Use TLS
EMAIL_HOST_USER = 'xxx@mail.com' # Your email address
EMAIL_HOST_PASSWORD = 'yyy' # Your email passwrod
DEFAULT_FROM_EMAIL = 'zzz' # Default from email address
Enter your organization's or personal email account credentials. Below are examples of common email providers for your reference:
Tip
The EMAIL_USE_TLS setting should be set to True or False depending on the configuration of your email service. Generally, email services that use port 587 require this to be set to True. For more details, please refer to: Django Email Settings.