diff --git a/apps/dbgate/5.2.7/.env.sample b/apps/dbgate/5.2.7/.env.sample new file mode 100644 index 00000000..b62e5791 --- /dev/null +++ b/apps/dbgate/5.2.7/.env.sample @@ -0,0 +1,3 @@ +CONTAINER_NAME="dbgate" +PANEL_APP_PORT_HTTP="3000" +DATA_PATH="./data" \ No newline at end of file diff --git a/apps/dbgate/5.2.7/data.yml b/apps/dbgate/5.2.7/data.yml new file mode 100644 index 00000000..07de7789 --- /dev/null +++ b/apps/dbgate/5.2.7/data.yml @@ -0,0 +1,17 @@ +additionalProperties: + formFields: + - default: 3000 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 端口 + required: true + rule: paramPort + type: number + - default: ./data + edit: true + envKey: DATA_PATH + labelEn: Data folder path + labelZh: 数据文件夹路径 + required: true + type: text diff --git a/apps/dbgate/5.2.7/docker-compose.yml b/apps/dbgate/5.2.7/docker-compose.yml new file mode 100644 index 00000000..46477786 --- /dev/null +++ b/apps/dbgate/5.2.7/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3" +services: + dbgate: + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - "${PANEL_APP_PORT_HTTP}:3000" + volumes: + - "${DATA_PATH}:/root/.dbgate" + image: "dbgate/dbgate:5.2.7" + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true \ No newline at end of file diff --git a/apps/dbgate/README.md b/apps/dbgate/README.md new file mode 100644 index 00000000..b105e44c --- /dev/null +++ b/apps/dbgate/README.md @@ -0,0 +1,181 @@ +[![NPM version](https://img.shields.io/npm/v/dbgate-serve.svg)](https://www.npmjs.com/package/dbgate-serve) +![GitHub All Releases](https://img.shields.io/github/downloads/dbgate/dbgate/total) +[![dbgate](https://snapcraft.io/dbgate/badge.svg)](https://snapcraft.io/dbgate) +[![dbgate](https://snapcraft.io/dbgate/trending.svg?name=0)](https://snapcraft.io/dbgate) +[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier) + + + +# DbGate - (no)SQL database client + +DbGate is cross-platform database manager. +It's designed to be simple to use and effective, when working with more databases simultaneously. +But there are also many advanced features like schema compare, visual query designer, chart visualisation or batch export and import. + +DbGate is licensed under MIT license and is completely free. + +* Try it online - [demo.dbgate.org](https://demo.dbgate.org) - online demo application +* **Download** application for Windows, Linux or Mac from [dbgate.org](https://dbgate.org/download/) +* Run web version as [NPM package](https://www.npmjs.com/package/dbgate-serve) or as [docker image](https://hub.docker.com/r/dbgate/dbgate) + +## Supported databases +* MySQL +* PostgreSQL +* SQL Server +* Oracle (experimental) +* MongoDB +* Redis +* SQLite +* Amazon Redshift +* CockroachDB +* MariaDB + + + + + + + + + + + + + + + + + + + +## Features +* Table data editing, with SQL change script preview +* Edit table schema, indexes, primary and foreign keys +* Compare and synchronize database structure +* ER diagram +* Light and dark theme +* Master/detail views, foreign key lookups +* Query designer +* Form view for comfortable work with tables with many columns +* JSON view on MongoDB collections +* Explore tables, views, procedures, functions, MongoDB collections +* SQL editor + * execute SQL script + * SQL code formatter + * SQL code completion + * Add SQL LEFT/INNER/RIGHT join utility +* Mongo JavaScript editor, execute Mongo script (with NodeJs syntax) +* Redis tree view, generate script from keys, run Redis script +* Runs as application for Windows, Linux and Mac. Or in Docker container on server and in web Browser on client. +* Import, export from/to CSV, Excel, JSON, NDJSON, XML +* Free table editor - quick table data editing (cleanup data after import/before export, prototype tables etc.) +* Archives - backup your data in NDJSON files on local filesystem (or on DbGate server, when using web application) +* Charts, export chart to HTML page +* For detailed info, how to run DbGate in docker container, visit [docker hub](https://hub.docker.com/r/dbgate/dbgate) +* Extensible plugin architecture +* Perspectives - nested table view over complex relational data, query designer on MongoDB databases + +## How to contribute +Any contributions are welcome. If you want to contribute without coding, consider following: + +* Tell your friends about DbGate or share on social networks - when more people will use DbGate, it will grow to be better +* Write review on [Slant.co](https://www.slant.co/improve/options/41086/~dbgate-review) or [G2](https://www.g2.com/products/dbgate/reviews) +* Create issue, if you find problem in app, or you have idea to new feature. If issue already exists, you could leave comment on it, to prioritise most wanted issues +* Create some tutorial video on [youtube](https://www.youtube.com/playlist?list=PLCo7KjCVXhr0RfUSjM9wJMsp_ShL1q61A) +* Become a backer on [GitHub sponsors](https://github.com/sponsors/dbgate) or [Open collective](https://opencollective.com/dbgate) +* Where a small coding is acceptable for you, you could [create plugin](https://dbgate.org/docs/plugin-development.html). Plugins for new themes can be created actually without JS coding + +Thank you! + +## Why is DbGate different +There are many database managers now, so why DbGate? +* Works everywhere - Windows, Linux, Mac, Web browser (+mobile web is planned), without compromises in features +* Based on standalone NPM packages, scripts can be run without DbGate (example - [CSV export](https://www.npmjs.com/package/dbgate-plugin-csv) ) +* Many data browsing functions based using foreign keys - master/detail, expand columns, expandable form view + +## Design goals +* Application simplicity - DbGate takes the best and only the best from old DbGate, [DatAdmin](https://www.softpedia.com/get/Internet/Servers/Database-Utils/DatAdmin-Personal.shtml), [DbMouse](https://www.softpedia.com/get/Internet/Servers/Database-Utils/DbMouse.shtml) and [SQL Database Studio](https://en.wikipedia.org/wiki/SQL_Database_Studio) +* Minimal dependencies + * Frontend - Svelte + * Backend - NodeJs, ExpressJs, database connection drivers + * JavaScript + TypeScript + * App - electron +* Platform independent - runs as web application in single docker container on server, or as application using Electron platform on Linux, Windows and Mac + + + +## How to run development environment + +Simple variant - runs WEB application: +```sh +yarn +yarn start +``` + +If you want more control, run WEB application: +```sh +yarn # install NPM packages +``` + +And than run following 3 commands concurrently in 3 terminals: +``` +yarn start:api # run API on port 3000 +yarn start:web # run web on port 5001 +yarn lib # watch typescript libraries and plugins modifications +``` +This runs API on port 3000 and web application on port 5001 +Open http://localhost:5001 in your browser + +If you want to run electron app: +```sh +yarn # install NPM packages +cd app +yarn # install NPM packages for electron +``` + +And than run following 3 commands concurrently in 3 terminals: +``` +yarn start:web # run web on port 5001 (only static JS and HTML files) +yarn lib # watch typescript libraries and plugins modifications +yarn start:app # run electron app +``` + +## How to run built electron app locally +This mode is very similar to production run of electron app. Electron doesn't use localhost:5001. + +```sh +cd app +yarn +``` + +```sh +yarn +yarn build:app:local +yarn start:app:local +``` + +## How to create plugin +Creating plugin is described in [documentation](https://github.com/dbgate/dbgate/wiki/Plugin-development) + +But it is very simple: + +```sh +npm install -g yo # install yeoman +npm install -g generator-dbgate # install dbgate generator +cd dbgate-plugin-my-new-plugin # this directory is created by wizard, edit, what you need to change +yarn plugin # this compiles plugin and copies it into existing DbGate installation +``` + +After restarting DbGate, you could use your new plugin from DbGate. + +## Logging +DbGate uses [pinomin logger](https://github.com/dbgate/pinomin). So by default, it produces JSON log messages into console and log files. If you want to see formatted logs, please use [pino-pretty](https://github.com/pinojs/pino-pretty) log formatter. \ No newline at end of file diff --git a/apps/dbgate/beta/.env.sample b/apps/dbgate/beta/.env.sample new file mode 100644 index 00000000..b62e5791 --- /dev/null +++ b/apps/dbgate/beta/.env.sample @@ -0,0 +1,3 @@ +CONTAINER_NAME="dbgate" +PANEL_APP_PORT_HTTP="3000" +DATA_PATH="./data" \ No newline at end of file diff --git a/apps/dbgate/beta/data.yml b/apps/dbgate/beta/data.yml new file mode 100644 index 00000000..07de7789 --- /dev/null +++ b/apps/dbgate/beta/data.yml @@ -0,0 +1,17 @@ +additionalProperties: + formFields: + - default: 3000 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 端口 + required: true + rule: paramPort + type: number + - default: ./data + edit: true + envKey: DATA_PATH + labelEn: Data folder path + labelZh: 数据文件夹路径 + required: true + type: text diff --git a/apps/dbgate/beta/docker-compose.yml b/apps/dbgate/beta/docker-compose.yml new file mode 100644 index 00000000..2243c71c --- /dev/null +++ b/apps/dbgate/beta/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3" +services: + dbgate: + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - "${PANEL_APP_PORT_HTTP}:3000" + volumes: + - "${DATA_PATH}:/root/.dbgate" + image: "dbgate/dbgate:beta" + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true \ No newline at end of file diff --git a/apps/dbgate/data.yml b/apps/dbgate/data.yml new file mode 100644 index 00000000..d5ad15bc --- /dev/null +++ b/apps/dbgate/data.yml @@ -0,0 +1,20 @@ +name: dbgate +tags: + - 工具 +title: 基于 Web 的用户界面，用于管理和浏览 SQL 数据库数据 +type: 工具 +description: 基于 Web 的用户界面，用于管理和浏览 SQL 数据库数据 +additionalProperties: + key: dbgate + name: Changedetection.io + tags: + - Tool + shortDescZh: 基于 Web 的用户界面，用于管理和浏览 SQL 数据库数据 + shortDescEn: Web based UI for managing and exploring SQL database data + type: tool + crossVersionUpdate: true + limit: 0 + recommend: 0 + website: https://dbgate.org + github: https://github.com/dbgate/dbgate + document: https://dbgate.org/docs/ \ No newline at end of file diff --git a/apps/dbgate/latest/.env.sample b/apps/dbgate/latest/.env.sample new file mode 100644 index 00000000..b62e5791 --- /dev/null +++ b/apps/dbgate/latest/.env.sample @@ -0,0 +1,3 @@ +CONTAINER_NAME="dbgate" +PANEL_APP_PORT_HTTP="3000" +DATA_PATH="./data" \ No newline at end of file diff --git a/apps/dbgate/latest/data.yml b/apps/dbgate/latest/data.yml new file mode 100644 index 00000000..07de7789 --- /dev/null +++ b/apps/dbgate/latest/data.yml @@ -0,0 +1,17 @@ +additionalProperties: + formFields: + - default: 3000 + edit: true + envKey: PANEL_APP_PORT_HTTP + labelEn: Port + labelZh: 端口 + required: true + rule: paramPort + type: number + - default: ./data + edit: true + envKey: DATA_PATH + labelEn: Data folder path + labelZh: 数据文件夹路径 + required: true + type: text diff --git a/apps/dbgate/latest/docker-compose.yml b/apps/dbgate/latest/docker-compose.yml new file mode 100644 index 00000000..5cad8b16 --- /dev/null +++ b/apps/dbgate/latest/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3" +services: + dbgate: + container_name: ${CONTAINER_NAME} + restart: always + networks: + - 1panel-network + ports: + - "${PANEL_APP_PORT_HTTP}:3000" + volumes: + - "${DATA_PATH}:/root/.dbgate" + image: "dbgate/dbgate:latest" + labels: + createdBy: "Apps" + +networks: + 1panel-network: + external: true \ No newline at end of file diff --git a/apps/dbgate/logo.png b/apps/dbgate/logo.png new file mode 100644 index 00000000..216ebdb3 Binary files /dev/null and b/apps/dbgate/logo.png differ