From ac7939954fade8e1098ff0acf83c158428d78163 Mon Sep 17 00:00:00 2001
From: Artem Niehrieiev <r.tem@tuta.io>
Date: Tue, 22 Oct 2024 08:08:30 +0000
Subject: [PATCH] Updated rocketadmin-agent Readme.md added empty config file
 for docker compose

---
 rocketadmin-agent/.config.env | 29 +++++++++++++++++++++++++++++
 rocketadmin-agent/README.md   | 30 ++++++++++++++++--------------
 2 files changed, 45 insertions(+), 14 deletions(-)
 create mode 100644 rocketadmin-agent/.config.env

diff --git a/rocketadmin-agent/.config.env b/rocketadmin-agent/.config.env
new file mode 100644
index 000000000..0dca944ce
--- /dev/null
+++ b/rocketadmin-agent/.config.env
@@ -0,0 +1,29 @@
+# Unique connection token, what you received, when you created connection on the "Autoadmin" main page
+CONNECTION_TOKEN=
+# Type of your database: oracledb, mysql, postgres, mssql;
+CONNECTION_TYPE=
+# Host, where your database is located
+CONNECTION_HOST=
+# Server port, where your database is located
+CONNECTION_PORT=
+# Your database username
+CONNECTION_USERNAME=
+# Your database password
+CONNECTION_PASSWORD=
+# Your database name
+CONNECTION_DATABASE=
+# Your database schema, if exists
+CONNECTION_SCHEMA=
+# Your database SID (it's instance id for oracle database)
+CONNECTION_SID=
+# SSL option. 1 - if you want to use ssl connection to your database, 0 - if you don't
+CONNECTION_SSL=0
+# SSL sertificate. It's required if you want use SSL connection to your database
+# .env files have some problems with multi-line values
+# (you need to replace line breaks with special characters \n and quote a line)
+# You can also write the key to a file /storage/ssl-cert.txt and leave this field blank. This is an easier way.
+CONNECTION_SSL_SERTIFICATE=
+# Writing logs to a text file (/storage/stored-logs/logs.txt. 1 - if you want to save logs in text file, 0 - if you don't
+LOGS_TO_TEXT_FILE=0
+#Azure ecnryption option. If your database located in Microsoft Azure cloud, and requires encryption type 1 or 0 - if it doesn't'
+CONNECTION_AZURE_ENCRYPTION=0
\ No newline at end of file
diff --git a/rocketadmin-agent/README.md b/rocketadmin-agent/README.md
index 1d9351354..76b2f90be 100644
--- a/rocketadmin-agent/README.md
+++ b/rocketadmin-agent/README.md
@@ -1,37 +1,39 @@
-# Autoadmin-agent
+# Rocketadmin-agent
 
-There are two options for installing Autoadmin-agent: using Docker Desktop (for MacOS and Windows) or using Docker Engine (for Linux).
+There are two options for installing Rocketadmin-agent: using Docker Desktop (for MacOS and Windows) or using Docker Engine (for Linux).
 
-
-## Installing autoadmin using docker
+## Installing rocketadmin using docker
 
 Open Terminal app and run following commands:
 
 ```bash
 
-docker pull autoadmin/agent
-docker run -e CONNECTION_TOKEN=connection_token -e CONNECTION_TYPE=mysql -e CONNECTION_USERNAME=your_username \
-    -e CONNECTION_PASSWORD=your_password -e CONNECTION_HOST=example.com autoadmin/agent
+docker pull rocketadmin/rocketadmin-agent:latest
+docker run -it rocketadmin/rocketadmin-agent:latest
+
 ```
 
+Running these commands will start the application in interactive mode, displaying a command line dialog where you can enter the necessary connection parameters.
+
 ## Install via Docker Compose
 
 First step is installing [Docker Engine](https://docker.com).
 On Linux, please install [Docker Compose](https://docs.docker.com/compose/install/) as well.
+
 > Note: Docker Desktop on Windows and MacOS already include Docker Compose.
 
-Second step – create **docker-compose.yml** file. 
-Copy and paste configuration from [(source file)](https://github.com/Autoadmin-org/autoadmin-agent/blob/master/docker-compose.yml) or download this file.
+Second step – create **docker-compose.yml** file.
+Copy and paste configuration from [(source file)](https://github.com/rocket-admin/rocketadmin/tree/main/rocketadmin-agent/docker-compose.yml) or download this file.
 
-Third step – create **.config.env** file in the same directory. 
-Copy and paste the contents of [(source file)](https://github.com/Autoadmin-org/autoadmin-agent/blob/master/.config.env) or download this file.
+Third step – create **.config.env** file in the same directory.
+Copy and paste the contents of [(source file)](https://github.com/rocket-admin/rocketadmin/tree/main/rocketadmin-agent/.config.env) or download this file.
 
 Fourth step – open **.config.env** file and specify all required credentials.
 
-
 Open Terminal app and run:
 
 ```sh
-docker-compose up --build
+docker compose up --build
 ```
-After sucessfull execution, new connection will appear in Autoadmin Connections List.
+
+After sucessfull execution, new connection will appear in Rocketadmin Connections List.