Orchestration: Running as systemd service

In this guide, you will learn:

• What the systemd service does and how it benefits Redact Enterprise
• How to install and uninstall the Redact Enterprise systemd service
• How to start, stop, and manage the service lifecycle
• How to monitor service status and view logs for troubleshooting

How to install and use the Redect Enterprise Service

1. Install the Service
   • Run the install.sh script and provide an installation directory:
     sudo ./install.sh /etc/redact
   • This creates the redact directory under /etc and installs the systemd service.
     
     
2. Uninstall the Service
   • To remove the service, use the uninstall.sh script with the same installation directory:
     sudo ./uninstall.sh /etc/redact
   • Uninstalling the service stops it, which may take up to a minute.
     
     
3. Start and Stop the Service
   • Once installed, you can start or stop the service with the following commands:
     • Start the Service:
       sudo systemctl start redact.service
       Note: Starting for the first time may take a few minutes as Docker images are downloaded.
     • Stop the Service:
       `sudo systemctl stop redact.service
       
       
4. Enable the Service on System Boot
   • To configure systemd to automatically start Redact Enterprise at boot
     sudo systemctl enable redact.service
   • Note: During reboots, all ongoing processing and temporary data will be lost.
     
     
5. Disable the Service
   • To prevent systemd from starting the service on boot:
     sudo systemctl disable redact.service
   • The service will remain active until stopped manually:
     sudo systemctl stop redact.service
     
     
6. Check Service Status
   • Check if the service is enabled:
     sudo systemctl is-enabled redact.service
   • View the current status and health of the service:
     sudo systemctl status redact.service
     
     
7. View Logs
   • Retrieve service logs to monitor operations or debug issues:
     journalctl -u redact.service
   • For further insights into running Docker containers, use:
     docker ps
   • Focus on the redact and redact-gpu containers for detailed status and logs.

Troubleshooting

If you encounter any issues during the installation or setup, please reach out to our team. We’ll assist you during the onboarding call to ensure a smooth deployment.