Skip to content

Commit

Permalink
Merge pull request #870 from rocket-admin/backend_rework_agent_docker…
Browse files Browse the repository at this point in the history
…file

Updated rocketadmin-agent Readme.md
  • Loading branch information
Artuomka authored Oct 22, 2024
2 parents e9fcb7c + ac79399 commit a744bf5
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 14 deletions.
29 changes: 29 additions & 0 deletions rocketadmin-agent/.config.env
Original file line number Diff line number Diff line change
@@ -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
30 changes: 16 additions & 14 deletions rocketadmin-agent/README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit a744bf5

Please sign in to comment.