@prostgles/prostgles 2.3.6-dev.1786548258

package/docs/12_Map_view.md

@@ -0,0 +1,56 @@
+<h1 id="map_view"> Map view </h1> 
+
+The map view allows you to visualize geographical data from your database.
+It requires the [PostGIS](https://postgis.net/) extension to be installed on your PostgreSQL database.
+It can display points, lines, and polygons based on geometry or geography columns in your tables or views.
+It supports multiple layers, custom basemaps, and various map controls for interaction.
+
+## Features
+
+- **Multiple layer support**: Display multiple layers of geographical data on the same map, each with its own data source and styling options.
+- **Linked/joined layers**: Add related layers with cross-filtering capabilities, allowing you to visualize relationships between different datasets. 
+- **Create and edit features**: Draw and edit points, lines, and polygons directly on the map, and save them back to the database. 
+- **Data-driven styling**: Style your map layers with custom colors or icons based on the attributes of your geographical data for better visualization.
+- **Custom basemaps**: Choose from different basemap options or add your own custom tiles for the map background.
+- **Map controls**: Interact with the map using controls for zooming, panning, and displaying cursor coordinates.
+
+<img src="./screenshots/map.svgif.svg" alt="Map view screenshot" style="border: 1px solid; margin: 1em 0;" />
+
+  - **Header section**: Contains menu button, title and window minimise/fullscreen controls.  
+    - **View title. Drag to re-arrange layout**: Shows the table/view name together with the geometry/geography column name used for the map visualization.  
+    - **Collapse the view**: Collapses the view, minimizing it to temporarily save space on the dashboard.   
+    - **Fullscreen**: Expands the view to fill the entire screen.  
+    - **Remove view**: Removes the view from the dashboard.  
+    - **Chart toolbar**: Toolbar for the chart view if not detached. By default, newly charts added will appear over the originating table/sql editor view. They can be detached to a separate window.  
+      - **Chart menu**: Menu for the chart view.  
+      - **Collapse chart**: Collapses the chart window, minimizing it to save space on the dashboard. It can then be restored by clicking the chart icon in the SQL editor top left quick actions section.  
+      - **Detach chart**: Detaches the chart from the parent view, allowing it to be moved and resized independently. It keeps the connection the originating table view to cross filter it.  
+      - **Close chart**: Closes the chart view, returning to the originatine table/sql editor view.  
+    - <a href="#map_view_menu">Map view menu</a>: Data refresh and display options.  
+  - <a href="#map_window_with_controls">Map window with controls</a>: Map visualization and controls for interacting with the map.  
+
+<h4 id="map_view_menu"> Map view menu </h4> 
+
+The map view menu provides options for configuring the map visualization, including data refresh, basemap settings, and layer management.
+
+  - **Data refresh**: Allows setting subscriptions or data refresh rates. By default every table subscribes to data changes.  
+  - **Basemap**: Allows setting the map tiles and projection.  
+    - **Projection**: Allows setting the map projection: Mercator (default) or Orthographic (allows a setting custom tile image for plan drawings).  
+  - **Layers**: Allows setting the map layers data source and style. The map supports multiple layers.  
+  - **Settings**: Allows setting the map layout options: aggregation limit, click behavior, etc.  
+
+<h4 id="map_window_with_controls"> Map window with controls </h4> 
+
+The map window contains the map visualization and controls for interacting with the map.
+It allows you to add layers, set the map extent behavior, and toggle cursor coordinates display.
+
+  - **Map layer manager**: Allows adding/removing layers to the map. Each layer can be configured with its own data source and style.  
+    - **Add layer**: Allows adding a new layer to the map. The available options are all the tables that have geometry or geography columns.  
+    - **Add OSM layer**: Allows adding a new layer based on OpenStreetMap data. This is useful for displaying additional map data like roads, restaurants, etc.  
+    - **Map basemap options**: Allows setting the map tiles and projection.  
+    - **Map opacity options**: Allows setting the opacity of the map layers.  
+  - **Show cursor coordinates**: Toggle displays the current cursor coordinates on the map.   
+  - **Map extent behavior**: Allows setting the map extent and auto-zoom behavior: Follow data, Follow map or Free roam.  
+  - **Zoom to data**: Zooms the map to fit the bounds of the data currently displayed.  
+  - **Add new feature**: Allows drawing and inserting a new feature: Point, Line or Polygon.  
+

package/docs/13_Timechart_view.md

@@ -0,0 +1,49 @@
+<h1 id="timechart_view"> Timechart view </h1> 
+
+The timechart view allows you to visualize time-series data from your database. 
+
+
+## Features
+
+- **Multiple layer support**: Display multiple layers of time-series data on the same chart, each with its own data source and styling options.
+- **Aggregation and grouping**: Configure aggregation functions and grouping options for each layer to analyze trends and patterns in your data effectively.
+- **Interactive exploration**: Interact with the chart using zooming, panning, and tooltips to explore your data in detail.
+
+<img src="./screenshots/timechart.svgif.svg" alt="Timechart view screenshot" style="border: 1px solid; margin: 1em 0;" />
+
+## Components
+
+  - **Header section**: Contains menu button, title and window minimise/fullscreen controls.  
+    - **View title. Drag to re-arrange layout**: Shows the table/view name together with the number of records matching the current filters.  
+    - **Collapse the view**: Collapses the view, minimizing it to temporarily save space on the dashboard.   
+    - **Fullscreen**: Expands the view to fill the entire screen.  
+    - **Remove view**: Removes the view from the dashboard.  
+    - **Chart toolbar**: Toolbar for the chart view if not detached. By default, newly charts added will appear over the originating table/sql editor view. They can be detached to a separate window.  
+      - **Chart menu**: Menu for the chart view.  
+      - **Collapse chart**: Collapses the chart window, minimizing it to save space on the dashboard. It can then be restored by clicking the chart icon in the SQL editor top left quick actions section.  
+      - **Detach chart**: Detaches the chart from the parent view, allowing it to be moved and resized independently. It keeps the connection the originating table view to cross filter it.  
+      - **Close chart**: Closes the chart view, returning to the originatine table/sql editor view.  
+    - <a href="#timechart_view_menu">Timechart view menu</a>: Timechart view menu  
+  - **Chart area with controls**: Timechart visualization.  
+    - **Layer manager**: Allows adding/removing layers from the chart. Each layer can be configured with its own data source and style.  
+      - **Layer list**: Displays the list of layers currently added to the chart.   
+        - **Layer color picker**: Allows setting the color for the layer. The color can be set for each column in the layer.  
+        - **Table name**: The name of the table used for the layer. This is the table that contains the data for the layer.  
+        - **Aggregation options**: Allows setting the y-axis options for the layer.  
+          - **Aggregation function**: Selects the aggregation function to be used for the layer. The available options are: Sum, Average, Min, Max, Count.  
+          - **Aggregation column**: Selects the numeric column to be used for the aggregation function.   
+          - **Group by**: Selects the column to group the data by. This is will create a line for each group by value.  
+          - **Close**: Closes the aggregation function popup.  
+        - **Toggle layer on/off**: Toggles the visibility of the layer on the chart. This allows you to hide or show the layer without removing it.  
+        - **Remove layer**: Removes the layer from the chart. This will delete the layer and its configuration.  
+      - **Add layer**: Allows adding a new layer to the chart. The available options are all the tables that have date or timestamp columns.  
+    - **Reset extent**: Resets the chart to the default extent, showing all data points. Visible when the chart was paned or zoomed.  
+    - **Layer legend**: Displays the layers currently added to the chart. Quick access to changing the layer color, aggregation type and group by.  
+    - **Add/Edit time filter**: Allows adding a time filter to the timechart. This will filter the data points based on the selected time range.  
+    - **Timechart canvas**: Zoomable and pannable canvas that displays the timechart. It shows the data points based on the selected layers and filters. Clicking on a point will add a filter with that time bucket.  
+
+<h4 id="timechart_view_menu"> Timechart view menu </h4> 
+
+The timechart view menu provides options for configuring the timechart.
+
+

package/docs/14_AI_Assistant.md

@@ -0,0 +1,64 @@
+<h1 id="ai_assistant"> AI Assistant </h1> 
+
+The AI assistant is an intelligent companion that helps you work more efficiently with your PostgreSQL databases. 
+It can generate SQL queries, explain database schemas, analyze data patterns, and assist with various database-related tasks through a conversational interface.
+MCP Servers can be used to extend the AI capabilities with custom tools and integrations.
+
+## Features
+
+- **Agentic Workflows**: Generate, save and re-run TypeScript automations in an isolated sandbox with granular access to data, MCP tools and filesystem.
+- **Progressive schema discovery**: Each conversation fetches only the table and tool schemas it actually needs, keeping the context window clean and focused.
+- **Granular per-chat permissions**: Configure database access, schema visibility, and tool permissions independently for each conversation
+- **Works with hosted and local models**: It supports OpenAI, Anthropic, Gemini, OpenRouter, Ollama, and OpenAI-compatible local models.
+- **Multimodal input with document support**: Attach files, convert supported documents and images into markdown context (Docling), and use speech-to-text (Faster Whisper).
+
+
+<img src="./screenshots/ai_assistant.svgif.svg" alt="AI assistant popup screenshot" style="border: 1px solid; margin: 1em 0;" />
+
+Supported AI Providers: OpenAI, Anthropic, Google Gemini, OpenRouter, Ollama and any other Local Models that support the openai spec. 
+
+*Note: AI providers are configured in Server Settings > LLM Providers*
+
+  - **Header actions**: Actions available in the header of the AI assistant popup.  
+    - **Chat settings**: Allows editing all chat settings and data as well deleting or cloning the current chat.  
+    - **Select chat**: Selects a chat from the list of available chats. Each chat represents a separate conversation with the AI assistant.  
+    - **New chat**: Creates a new chat with the AI assistant.  
+    - **Toggle fullscreen**: Toggles the fullscreen mode for the AI assistant popup.  
+    - **Close popup**: Closes the AI assistant popup.  
+  - **Chat messages**: List of messages in the current chat.  
+  - <a href="#message_input">Message input</a>: Input field for entering messages to the AI assistant and quick actions.  
+
+<h3 id="message_input"> Message input </h3> 
+
+The message input area allows you to write text, attach files and control other aspects of the AI assistant (change model, add/remove tools, speech to text).
+
+  - **Message input**: Input field for entering messages to the AI assistant. Pressing Shift+Enter creates a new line.  
+  - <a href="#mcp_tools_allowed">MCP tools allowed</a>: Opens the MCP tools menu for the current chat. Default tools: filesystem, git, github, google-maps, memory, playwright, web, webdev, slack, apify  
+  - **Database access**: Opens the database access settings for the current chat. This controls how the AI assistant can interact with the current database.  
+  - **Prompt Selector**: Opens the prompt details for the current chat, allowing you to manage the prompt template and other related settings.  
+    - **Prompt preview**: Preview of the prompt with context variables filled in.  
+  - **LLM Model**: Selects the LLM model to be used for the current chat. Different models may have different capabilities and performance.   
+    - **Select model**: Selects this LLM model for the current chat.  
+    - **Add model credentials**: Opens the form to add llm provider credentials for the selected LLM model.  
+  - **Attach files**: Attaches files to be sent to the AI assistant along with the message. Supported file types may vary depending on the AI model and configuration.  
+  - **Speech to Text**: Opens the speech-to-text input options, allowing you to send audio recordings or transcribe audio messages to send to the AI assistant. Right click to open speech-to-text settings.  
+  - **Send message**: Sends the entered message to the AI assistant.  
+
+<h4 id="mcp_tools_allowed"> MCP tools allowed </h4> 
+
+MCP Servers extend the capabilities of the AI assistant by providing custom tools and integrations.
+
+  - **Add MCP server**: Opens the form to add a new MCP server for the current chat.  
+    - **MCP tool json config**: JSON configuration for the MCP tool to be added.  
+    - **Add MCP server**: Adds the specified MCP server to the current chat.  
+  - **Stop/Start all MCP Servers**: Quick way to stop/restart all MCP servers.  
+  - **Search tools**: Searches for specific MCP tools in the list of available tools.  
+  - **MCP tools**: List of available MCP tools. To allow a tool to be used in the current chat it must be ticked. Each tool represents a specific functionality or integration.  
+    - **MCP server name**: Name of the parent MCP server associated with the tool.  
+    - **MCP server tools**: List of available tools for the selected MCP server. Click to enable or disable a specific tool for the current chat.  
+    - **MCP Server Logs**: Opens the logs for the selected MCP server, allowing you to view its activity and status.  
+    - **MCP Server Config**: Opens the configuration for the selected MCP server, allowing you to manage its settings.  
+      - **Save config**: Saves the configuration for the selected MCP server.  
+    - **Reload MCP tools**: Reloads the MCP tools for the selected MCP server, updating the list of available tools.  
+    - **Enable/Disable MCP server**: Enables or disables the selected MCP server for all chats. If configuration is required a popup will be shown.  
+

package/docs/15_Connection_configuration.md

@@ -0,0 +1,20 @@
+<h1 id="connection_configuration"> Connection configuration </h1> 
+
+Configure the selected database connection. Set connection details, manage users, and customize settings.
+<img src="./screenshots/connection_config.svgif.svg" alt="Connection configuration" style="border: 1px solid; margin: 1em 0;" />
+
+- <a href="#connection_details">Connection details</a>: Edit connection parameters such as host, port, database name, and other connection settings.  
+- **Status monitor**: View real-time connection status, running queries, and system resource usage.  
+- <a href="#access_control">Access control</a>: Manage user permissions and access rules for this database connection.  
+- <a href="#file_storage">File storage</a>: Configure file upload and storage settings for this connection.  
+- <a href="#backup_and_restore">Backup and Restore</a>: Manage database backups and restore operations.  
+- **Web app**: React based web development environment (experimental feature).  
+- <a href="#api">API</a>: Configure API access settings and view API documentation.  
+- **Table config**: Advanced table configuration using TypeScript (experimental feature).  
+- **Server-side functions**: Configure and manage server-side functions (experimental feature).  
+
+<h2 id="connection_details"> Connection details </h2> 
+
+Connection settings, credentials, and other parameters to ensure your connection is configured correctly.
+
+

package/docs/16_Access_control.md

@@ -0,0 +1,12 @@
+<h1 id="access_control"> Access control </h1> 
+
+>  Not available on Desktop version
+  
+Manage user permissions and access rules for this database connection.
+<img src="./screenshots/access_control.svgif.svg" alt="Access control" style="border: 1px solid; margin: 1em 0;" />
+
+  - **Create Access Rule**: Add a new access control rule to define user permissions.  
+  - **Save Access Rule**: Save changes to the current access control rule.  
+  - **Cancel Changes**: Cancel editing the current access control rule.  
+  - **Remove Rule**: Delete the selected access control rule.  
+

package/docs/17_File_storage.md

@@ -0,0 +1,8 @@
+<h1 id="file_storage"> File storage </h1> 
+
+Configure file upload and storage settings for this connection.
+
+<img src="./screenshots/file_storage.svg" alt="File Storage Configuration" style="border: 1px solid; margin: 1em 0;" />
+
+  - **Enable File Storage**: Enable file upload and storage capabilities for this connection.  
+

package/docs/18_Backup_and_Restore.md

@@ -0,0 +1,22 @@
+<h1 id="backup_and_restore"> Backup and Restore </h1> 
+
+Manage database backups and restore operations for this PostgreSQL connection. 
+Create reliable backups using PostgreSQL's native tools and restore 
+your data when needed.
+
+Backups can be saved to a local file system or to cloud storage to AWS S3.
+Similarly, you can restore backups from local files or from AWS S3.
+
+<img src="./screenshots/backup_and_restore.svgif.svg" alt="Backup and Restore" style="border: 1px solid; margin: 1em 0;" />
+
+  - **Create Backup**: Start a new database backup operation.  
+  - **Automatic Backups**: Configure scheduled automatic backups for this database.  
+    - **Enable Automatic Backups**: Enable or disable automatic backup scheduling.  
+  - **Backups in Progress**: Monitor and manage ongoing backup operations.  
+    - **View Logs**: View real-time logs of the ongoing backup operation.  
+  - **Restore from File**: Initiate a database restore operation from a local backup file.  
+  - **Completed Backups**: View and manage completed backup operations.  
+    - **Delete Backup**: Delete the selected backup file from storage. Will ask for confirmation.  
+    - **Download Backup**: Download the selected backup file to your local system.  
+    - **Restore Backup**: Restore a database from a selected backup file. Will ask for confirmation.  
+

package/docs/19_API.md

@@ -0,0 +1,20 @@
+<h1 id="api"> API </h1> 
+
+The API section allows you to configure the API access settings for your application.
+This enables programmatic access to your application's data and functionality via HTTP or WebSocket protocols.
+Generated database types can be used to interact with the API in a type-safe manner through our TypeScript client library.
+Code snippets are provided to help you get started with using the API in your applications.
+You can also manage API tokens for authentication and access control.
+
+You can set the URL path for the API, manage allowed origins for CORS requests, and create or view API tokens for accessing the API. The API supports both WebSocket and HTTP protocols.
+
+  - **API URL Path**: Set the URL path for the API. This is the base path for all API endpoints.  
+  - **Allowed Origin Alert**: Will only appear if the allowed origin is not set.  
+    - **Allowed Origin**: Set the allowed origin for CORS requests. This controls which domains can make cross-origin requests to this app by setting the Access-Control-Allow-Origin header.  
+  - **Websocket API usage examples**: View examples of how to use the API using typescript and javascript  
+  - **HTTP API usage examples**: View examples of how to use the API using typescript and javascript  
+  - **API Tokens**: Shows existing API tokens and allows you to create new ones.  
+    - **Create API Token**: Create a new API token for accessing the API. Tokens can be used for both WebSocket and HTTP API access.  
+      - **Expires in (days)**: Set the number of days until the token expires. After expiration, the token will no longer be valid.  
+      - **Generate Token**: Click to generate a new API token. The token will be displayed once generated. After generation, the code examples will be updated to include the new token.  
+

package/docs/20_Server_Settings.md

@@ -0,0 +1,28 @@
+<h1 id="server_settings"> Server Settings </h1> 
+
+Manage server settings to enhance security, configure authentication methods, and set up LLM providers.
+<img src="./screenshots/server_settings.svg" alt="Server Settings" style="border: 1px solid; margin: 1em 0;" />
+
+- **Security**: Security. Configure domain access, IP restrictions, session duration, and login rate limits to enhance security.  
+  - **Settings form**: Configure server settings.  
+- **Authentication**: Manage user authentication methods, default user roles, and third-party login providers to control access.  
+  - **Website URL**: Website URL. Used for email and third-party login redirect URL. When first visiting the app as an admin user, it is automatically set to the current URL which will trigger a page refresh.  
+  - **Default user type**: The default user type assigned to new users. Defaults to 'default'.  
+  - <a href="#email_signup">Email signup</a>: Email signup/magic-link authentication setup.  
+  - **Third-party login providers**: Third-party login providers (OAuth2)  
+- **MCP Servers**: Manage MCP servers and tools that can then be used in the Ask AI chat  
+- **LLM Providers**: Manage LLM providers, credentials and models to be used in the Ask AI chat  
+- **Services**: Manage services  
+
+<h3 id="email_signup"> Email signup </h3> 
+
+Provide SMTP or AWS SES credentials to enable email signup and magic-link authentication. 
+By default users authenticate using a password.
+
+  - **Enable/Disable email signup toggle**: Enable email signup. This will allow users to sign up and log in using their email address.  
+  - **Signup type**: Signup type. Choose between 'withPassword' or 'withMagicLink'.  
+  - **Email verification**: SMTP and email template setup.  
+    - **Email provider setup**: SMTP settings for sending registration/magic-link emails. Allowed providers: SMTP (host, port, username, password) or AWS SES (region, accessKeyId, secretAccessKey).  
+    - **Email Template setup**: Email template for registration/magic-link emails  
+    - **Test and save**: Test and Save SMTP and email template settings.  
+

package/docs/21_Account.md

@@ -0,0 +1,21 @@
+<h1 id="account"> Account </h1> 
+
+Manage your account settings, security preferences, and API access.
+
+<img src="./screenshots/account.svgif.svg" alt="Account Page" style="border: 1px solid; margin: 1em 0;" />
+
+- **Account details**: View and update your account information.  
+  - **Account information**: View all account details and associated data (workspaces, dashboards, views, etc.)  
+- **Security**: Manage your account security settings.  
+  - **Two-factor authentication**: Set up and manage two-factor authentication for enhanced security.  
+    - **Generate QR Code**: Generate a QR code to set up 2FA with your authenticator app.  
+    - **Can't scan QR code**: View manual setup instructions if you can't scan the QR code.  
+    - **Confirm code**: Enter the code from your authenticator app to enable 2FA.  
+    - **Enable 2FA**: Complete the 2FA setup process by confirming the code.  
+    - **Base64 secret**: Manual setup secret key for your authenticator app.  
+  - **Disable 2FA**: Turn off two-factor authentication for your account.  
+  - **Change password**: Change your account password.  
+  - **Active sessions**: View and manage your active web sessions.  
+- **API**: View and manage your API access settings.  
+  - **API Details**: View your API credentials and configuration.  
+

package/docs/22_Command_Palette.md

@@ -0,0 +1,10 @@
+<h1 id="command_palette"> Command Palette </h1> 
+
+Keyboard-driven navigation to different parts of the application without having to browse through menus or panels. 
+
+Press <kbd>Ctrl+K</kbd> to open the command palette popup. Type to search through the documentation for functionality, settings, and other sections.
+<img src="./screenshots/command_palette.svgif.svg" alt="Command Palette" style="border: 1px solid; margin: 1em 0;" />
+
+- **Search commands input**: Type to search for commands and actions  
+- **Search results**: List of matching commands and actions. Press Enter to execute/go to the selected command.  
+