structure updates

tech_docs/python/Supervisor.md

@@ -0,0 +1,69 @@
+In the intersection of Python and Linux for automation and process management, `Supervisor` emerges as a critical tool. Supervisor is a client/server system that allows its users to monitor and control a number of processes on UNIX-like operating systems. It's designed to start processes at boot and keep them running in the desired state according to a configuration file. While Supervisor itself is an application written in Python, it effectively utilizes Python's capabilities to manage system processes, making it an indispensable tool for managing a complex environment of Python applications and scripts.
+
+### Supervisor Reference Guide
+
+#### Installation
+Supervisor can be installed via pip, but it may require system-level privileges to install globally or configure certain aspects:
+```
+pip install supervisor
+```
+
+#### Configuration
+Supervisor relies on a configuration file, typically named `supervisord.conf`, to determine which programs it should manage. The configuration file specifies how each program should be started, how many instances should run, how they should be restarted if they exit, and more.
+
+##### Sample Configuration
+Here's a basic example of what entries in a `supervisord.conf` file might look like:
+```ini
+[supervisord]
+logfile=/var/log/supervisor/supervisord.log
+loglevel=info
+user=root
+
+[program:your_program]
+command=/usr/bin/python3 /path/to/your_script.py
+autostart=true
+autorestart=true
+stderr_logfile=/var/log/your_program.err.log
+stdout_logfile=/var/log/your_program.out.log
+```
+
+#### Managing Processes
+Once Supervisor is installed and configured, you can use the `supervisorctl` command to manage processes defined in the configuration file.
+
+##### Starting Supervisor
+To start Supervisor with your configuration:
+```
+supervisord -c /path/to/your/supervisord.conf
+```
+
+##### Using `supervisorctl`
+`supervisorctl` provides a command-line interface to interact with the `supervisord` process:
+- To **start a program**: `supervisorctl start your_program`
+- To **stop a program**: `supervisorctl stop your_program`
+- To **restart a program**: `supervisorctl restart your_program`
+- To **view the status of all programs**: `supervisorctl status`
+
+#### Web Interface
+Supervisor can be configured to provide a web-based interface for monitoring and controlling processes. This is particularly useful for managing multiple processes across different servers.
+
+```ini
+[inet_http_server]
+port=127.0.0.1:9001
+username=user ; Basic auth username
+password=secret ; Basic auth password
+```
+
+Adding the above section to your `supervisord.conf` enables the web interface.
+
+#### Integration with Python and Linux
+- **Custom Scripts**: Supervisor can manage any process, including Python scripts, making it ideal for Python developers needing to ensure their scripts run continuously.
+- **Linux System Integration**: It integrates seamlessly with Linux systems, allowing Python applications to be started at boot and monitored.
+- **Log Management**: Supervisor handles logging for all managed processes, simplifying the debugging and monitoring of Python applications.
+
+#### Use Cases
+Supervisor is extensively used in environments where Python applications need to be kept running in the background indefinitely, such as web applications, data processing scripts, or any long-running Python service.
+
+#### Security Considerations
+When using Supervisor, especially when exposing the web interface, ensure that access is properly secured to prevent unauthorized control over your processes.
+
+Supervisor bridges the world of Python application development with Linux system administration, providing a robust toolset for managing long-running Python applications. Its ability to ensure that processes are always running in their desired state, coupled with powerful configuration and management capabilities, makes it an essential tool for developers and system administrators alike.