pakcages

website/docs/admin/services/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Services",
+  "position": 7,
+  "link": {
+    "type": "generated-index"
+  }
+}

website/docs/admin/services/allocation.md

@@ -0,0 +1,11 @@
+---
+sidebar_position: 4
+---
+
+# Resource Allocation
+
+:::info
+This feature is still experimental.
+:::
+
+

website/docs/admin/services/docker.md

@@ -0,0 +1,59 @@
+---
+sidebar_position: 3
+---
+
+# Docker
+
+![openadmin docker settings](/img/admin/adminpanel_docker_settings.png)
+
+
+To download Docker images, click the "update images" button.
+
+To remove an unnecessary image, click the delete button next to the image and confirm your action in the pop-up modal.
+
+
+## Docker images
+
+Docker images serve as the foundation for OpenPanel user accounts, determining the technology stack available to the user.
+
+
+### Update images
+
+Updating Docker images involves downloading the latest versions from the openpanel servers, and these updated images will be used only for new users. Existing users' setups will remain unaffected.
+
+To update docker images click on the 'Update images' button:
+![openadmin docker update 1](/img/admin/openadmin_docker_update1.png) 
+
+### Delete images
+
+To remove an unnecessary image, click the delete button next to the image and confirm in the pop-up modal:
+
+Step 1.             |  Step 2.
+:-------------------------:|:-------------------------:
+![openadmin docker delete image step 1](/img/admin/openadmin_docker_delete1.png)  |  ![openadmin docker delete image  step 2](/img/admin/openadmin_docker_delete2.png)
+
+
+:::info
+image can not be deleted if it is in use.
+:::
+
+
+### Add images
+
+Currently images can only be added from terminal: [`docker pull`](https://docs.docker.com/reference/cli/docker/image/pull/)
+
+## Docker info
+
+To view current [docker system info](https://docs.docker.com/reference/cli/docker/system/info/) click on the ![openadmin docker info 1](/img/admin/openadmin_docker_info1.png) button:
+
+![openadmin docker info 1](/img/admin/openadmin_docker_info2.png)
+
+
+## Total Resource Usage
+
+Under 'Docker Resource Usage Settings' you can configure the maximum memory and CPU percentages of server resources available for all users' Docker containers.
+
+![openadmin docker cpu settings](/img/admin/openadmin_docker_cpu.png)
+
+We advise against setting it above 90% ([BUG#117:Slow TTFB caused by the docker_limit.slice ckgroup ](https://github.com/stefanpejcic/OpenPanel/issues/117)).
+

website/docs/admin/services/log_viewer.md

@@ -0,0 +1,62 @@
+---
+sidebar_position: 5
+---
+
+# Log Viewer
+
+The *OpenAdmin > Services > View Log Files* feature enables Administrators to access and monitor logs for both OpenPanel and system services.
+
+![log viewer page](/img/admin/openadmin_services_logs.png)
+
+## How to View Log Files
+
+Navigate to *Services > View Log Files*
+
+Select the log file you would like to view and optionally number of lines from the file.
+
+After selecting a log file, two new buttons appear under the log content: 
+- *Delete* - will empty the file contents
+- *Download* - will download the entire log file to your browser.
+
+
+## How to add more files to OpenAdmin Log Viewer
+
+This functionality supports modularity by allowing customization of the log files displayed in the viewer.
+
+
+List of default log files: https://raw.githubusercontent.com/stefanpejcic/openpanel-configuration/main/openadmin/config/log_paths.json
+
+To define custom log files for the viewer:
+
+1. Edit Configuration File:
+   Modify the file located at `/etc/openpanel/openadmin/config/log_paths.json`. This file should contain entries in JSON format where each key-value pair represents a log file name and its corresponding path.
+   
+   Here is an example of what the log_paths.json file might look like:
+   Simply edit the file `/etc/openpanel/openadmin/config/log_paths.json` and in it set the desired log files and names:
+   ```json
+   {
+     "Nginx Access Log": "/var/log/nginx/access.log",
+      "Nginx Error Log": "/var/log/nginx/access.log",
+      "OpenAdmin Access Log": "/var/log/openpanel/admin/access.log",
+      "OpenAdmin Error Log": "/var/log/openpanel/admin/error.log",
+      "OpenAdmin API Log": "/var/log/openpanel/admin/api.log",
+      "Custom Service Log": "/path/to/custom/service.log"
+      "Syslog": "/var/log/syslog"
+   }
+   ```
+   Replace `/path/to/custom/service.log` with actual path to your custom log files.
+
+2. Verify JSON Validity:
+   Ensure that the log_paths.json file is formatted correctly as JSON. Any syntax errors in the JSON file will prevent the custom log files from appearing in the viewer.
+   You can check the validity of your JSON file by using a command-line JSON processor like jq:
+   ```bash
+   cat /etc/openpanel/openadmin/config/log_paths.json | jq
+   ```
+   If the JSON is valid, `jq` will output the parsed JSON structure. If there are any errors, `jq` will indicate where the problem lies.
+
+3. View Custom Logs in Viewer:
+   After saving the changes, navigate to *OpenAdmin > Services > View Log Files* in the interface. The custom log files you specified in log_paths.json should now appear alongside the default logs.
+   
+By following these steps, you can effectively customize the log files displayed in the OpenAdmin log viewer according to your specific requirements. This flexibility allows you to monitor logs from both standard services and any custom applications or services you integrate with OpenPanel.
+
+

website/docs/admin/services/nginx.md

@@ -0,0 +1,52 @@
+---
+sidebar_position: 2
+---
+
+# Nginx Configuration
+
+The *OpenAdmin > Services > Nginx Configuration* feature enables Administrators to view current Nginx status and edit configuration.
+
+![Nginx Configuration OpenAdmin](/img/admin/openadmin_services_nginx.png)
+
+## How to View Nginx Configuration
+
+Navigate to *Services > Nginx Configuration*
+
+Displayed information:
+- *Status* - Current status of the Nginx service
+- *Version* - Current version
+- *Active Connections* - The current number of active client connections including Waiting connections.
+- *Virtual Hosts* - The current number of virtualhosts (domain) files.
+- *Modules* - Lists installed Nginx modules and compiled flags
+- *Current Reading Connections* - The current number of connections where nginx is reading the request header.
+- *Current Writing Connections* - The current number of connections where nginx is writing the response back to the client.
+- *Current Waiting Connections* - The current number of idle client connections waiting for a request.
+- *Total Accepted Connections* - The total number of accepted client connections since the Nginx service is active.
+- *Total Handled Connections* - The total number of handled connections. Generally, the parameter value is the same as accepts unless some resource limits have been reached (for example, the worker_connections limit).
+- *Total Requests* - The total number of client requests since the Nginx service is active.
+
+## How to stop/start Nginx
+
+Navigate to *Services > Nginx Configuration*
+
+Under the 'Actions' section click on the button:
+
+- *Start* - `service nginx start`
+- *Stop* - `service nginx stop`
+- *Restart* - `service nginx restart`
+- *Reload* - `service nginx reload`
+- *Validate* - `nginx -t`
+
+
+## How to edit Nginx Configuration
+
+This section allows you to view and edit configuration for the Nginx webserver. 
+
+Select the configuration file you would like to view or edit.
+
+After making changes click on the Save button.
+
+OpenPanel automatically backs up the configuration file. It runs nginx -t to validate the changes; if successful, the webserver reloads, applying the new configuration instantly.
+
+In case of an error in the configuration, OpenPanel displays the exact issue and reverts to the previous backup file.
+

website/docs/admin/services/status.md

@@ -0,0 +1,14 @@
+---
+sidebar_position: 1
+---
+
+# Services Status
+
+*OpenAdmin > Services > Status* allows Administrators to view current status and manage monitored system services or Docker containers.
+
+![services_page](/img/admin/openadmin_services_status.png)
+
+To add custom services to the list, edit the `/etc/openpanel/openadmin/config/services.json` file.
+
+Default OpenPanel services are actively monitored by the SentinelAI and on failure, OpenAdmin will automatically try to determinate the root cause and restart them. If you manually stop a service, you should also disable this feature from the  [OpenAdmin Notifications](/docs/admin/notifications/) page.
+