Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
docs: cleanup and fix some documentation
Kyle Mendell37e8ccdd25b1
diff --git a/docs/docs/api/endpoints.md b/docs/docs/api/endpoints.mddeleted file mode 100644index c48e56e9a..000000000--- a/docs/docs/api/endpoints.md+++ /dev/null@@ -1,14 +0,0 @@-----sidebar_position: 2-title: API Endpoints------# API Endpoints--As outlined in the [API Overview](./overview.md), **Arcane does not currently expose a public REST API with defined endpoints for external consumption.**--The application's backend logic is handled internally by the SvelteKit server, which communicates directly with the Docker Engine API. Any API routes defined within the `src/routes` directory are considered internal implementation details and are subject to change without notice. They are not intended for direct use by external applications or scripts.--## Accessing Docker Programmatically--If you need to interact with Docker programmatically, please refer to the official **[Docker Engine API documentation](https://docs.docker.com/engine/api/v1.45/)**. This is the standard and supported way to automate Docker operations.diff --git a/docs/docs/api/overview.md b/docs/docs/api/overview.mddeleted file mode 100644index 45e3dc8e1..000000000--- a/docs/docs/api/overview.md+++ /dev/null@@ -1,28 +0,0 @@-----sidebar_position: 1-title: API Overview------# API Overview--## Interacting with the Docker Engine API--Arcane functions primarily as a user interface and management layer on top of the **Docker Engine API**. It does not expose its own public REST API for external applications to consume directly.--Instead, Arcane's backend (built with SvelteKit) communicates with the Docker daemon using the [Docker Engine API](https://docs.docker.com/engine/api/) via the [Dockerode](https://github.com/apocas/dockerode) library.--## Internal Communication--The communication between the Arcane frontend (running in your browser) and the Arcane backend (the Node.js server) happens through SvelteKit's built-in mechanisms:--- **Load Functions:** Used for fetching data required to render pages.-- **Form Actions:** Used for handling user submissions like starting/stopping containers or modifying settings.-- **API Routes (Server Endpoints):** Specific endpoints within `src/routes` might be defined for certain backend operations, but these are generally considered internal implementation details of Arcane.--## For External Integrations--If you need programmatic access to manage Docker, you should interact directly with the official **[Docker Engine API](https://docs.docker.com/engine/api/v1.45/)**. Arcane provides a user-friendly interface for this API but does not act as an API gateway itself.--## Future Considerations--While a public API for Arcane is not currently available, it might be considered for future development if there is significant demand for external integrations specific to Arcane's features (beyond standard Docker operations). If you have a use case for such an API, please consider opening a [Feature Request](https://github.com/ofkm/arcane/issues/new?template=feature.yml).diff --git a/docs/docs/development/building.md b/docs/docs/development/building.mdindex e7d76731b..99caf2881 100644--- a/docs/docs/development/building.md+++ b/docs/docs/development/building.md@@ -20,7 +20,7 @@ This guide explains how to build the Arcane application from its source code. ThOpen your terminal and clone the Arcane repository (replace `<your-repository-url>` with the actual URL):```bash- git clone <your-repository-url> arcane+ git clone https://github.com/ofkm/arcanecd arcane```@@ -42,7 +42,7 @@ This guide explains how to build the Arcane application from its source code. Thnpm run dev```- This will start a local development server, typically accessible at `http://localhost:5173` (check the terminal output for the exact URL).+ This will start a local development server, typically accessible at `http://localhost:3000` .4. **Linting and Formatting (Optional):**Before building, you might want to check for code style issues:diff --git a/docs/docs/development/contributing.md b/docs/docs/development/contributing.mdindex 7716a7ecb..b91939851 100644--- a/docs/docs/development/contributing.md+++ b/docs/docs/development/contributing.md@@ -54,7 +54,7 @@ Thank you for your interest in contributing to Arcane! We welcome contributions9. **Keep Your Branch Updated:** Periodically update your branch with the latest changes from the upstream repository:```bashgit fetch upstream- git rebase upstream/main # Or the appropriate default branch name+ git rebase upstream/main```10. **Push Your Branch:** Push your changes to your forked repository:```bash@@ -67,10 +67,6 @@ Thank you for your interest in contributing to Arcane! We welcome contributions## Code Style-Arcane uses [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to enforce code style and consistency. Please run `npm run lint` and `npm run format` before committing your changes. Configuration files (`.eslintrc.cjs`, `.prettierrc.json`) are included in the repository.--## Code of Conduct--While we don't have a formal Code of Conduct document yet, we expect all contributors to interact respectfully and constructively. Please be welcoming and considerate of others in all discussions and contributions.+Arcane uses [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to enforce code style and consistency. Please run `npm run lint` and `npm run format` before committing your changes. Configuration files (`.eslint.config.js`, `.prettierrc`) are included in the repository.Thank you again for contributing to Arcane!diff --git a/docs/docs/features/networks/_category_.json b/docs/docs/features/networks/_category_.jsonnew file mode 100644index 000000000..f314764cb--- /dev/null+++ b/docs/docs/features/networks/_category_.json@@ -0,0 +1,5 @@+{+ "label": "Networks",+ "collapsible": true,+ "collapsed": true+}diff --git a/docs/docs/features/volumes/_category_.json b/docs/docs/features/volumes/_category_.jsonnew file mode 100644index 000000000..035d8f774--- /dev/null+++ b/docs/docs/features/volumes/_category_.json@@ -0,0 +1,5 @@+{+ "label": "Volumes",+ "collapsible": true,+ "collapsed": true+}diff --git a/docs/docs/getting-started/configuration.md b/docs/docs/getting-started/configuration.mdindex da0f37c51..3dc7ead28 100644--- a/docs/docs/getting-started/configuration.md+++ b/docs/docs/getting-started/configuration.md@@ -1,5 +1,5 @@----sidebar_position: 3+sidebar_position: 2title: Configuration---@@ -11,18 +11,29 @@ Arcane offers several ways to configure its behavior, primarily through a JSON cThe main configuration for Arcane is managed through the `app-settings.json` file located in the application's data directory (typically `/app/data` inside the container).-Here's the default structure and settings:+Here's the example structure and settings:```json// filepath: /app/data/app-settings.json{- "dockerHost": "unix:///var/run/docker.sock",- "autoRefresh": true,- "pollingInterval": 5,- "stacksDirectory": "/app/data/stacks"+ "dockerHost": "unix:///var/run/docker.sock",+ "autoUpdate": false,+ "autoUpdateInterval": 60,+ "pollingEnabled": false,+ "pollingInterval": 10,+ "pruneMode": "all",+ "stacksDirectory": "/app/data/stacks",+ "auth.sessionTimeout": 60,+ "externalServices": {},+ "auth": {+ "localAuthEnabled": true,+ "sessionTimeout": 60+ }}```+**_While you can mount a config file, Its recommended to use the Arcane UI to configure the settings._**+### Configuration Options- **`dockerHost`** (`string`)@@ -52,7 +63,7 @@ Here's the default structure and settings:## Configuration with Docker-When running Arcane using Docker or Docker Compose (as shown in the example [`docker-compose.yml`](#docker-composeyml)), you can manage configuration in a few ways:+When running Arcane using Docker or Docker Compose (as shown in the example [`docker-compose.yml`](https://github.com/ofkm/arcane/blob/main/docker-compose.yml)), you can manage configuration in a few ways:### 1. Mounting the Data Directorydiff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.mddeleted file mode 100644index e03c1ebe4..000000000--- a/docs/docs/getting-started/installation.md+++ /dev/null@@ -1,33 +0,0 @@-----sidebar_position: 2-title: Manual Installation------# Installing Arcane--This guide will walk you through the installation of Arcane.--## Prerequisites--Before installing Arcane, ensure you have:--- Docker installed (version 20.10.0 or higher)-- Node.js (version 16 or higher)--## Installation Methods--### Using Docker--```bash-docker pull arcane/arcane:latest-docker run -d -p 3000:3000 -v /var/run/docker.sock:/var/run/docker.sock arcane/arcane:latest-```--### Using NPM--```bash-npm install -g arcane-ui-arcane-ui-```--Once installed, you can access Arcane at [http://localhost:3000](http://localhost:3000).diff --git a/docs/docs/getting-started/quickstart.md b/docs/docs/getting-started/quickstart.mdindex 1d642a367..92d5d26dd 100644--- a/docs/docs/getting-started/quickstart.md+++ b/docs/docs/getting-started/quickstart.md@@ -19,7 +19,7 @@ This guide provides the fastest way to get Arcane up and running using Docker CoOpen your terminal and clone the Arcane repository:```bash- git clone https://github.com/ofkm/arcane arcane+ git clone https://github.com/ofkm/arcanecd arcane```@@ -57,5 +57,4 @@ This guide provides the fastest way to get Arcane up and running using Docker Co## Next Steps- Explore the Arcane interface to manage your containers, images, volumes, and networks.-- For more detailed installation options or troubleshooting, see the full **[Installation](./installation.md)** guide.- Learn how to customize Arcane's behavior in the **[Configuration](./configuration.md)** guide.diff --git a/docs/docs/getting-started/requirements.md b/docs/docs/getting-started/requirements.mddeleted file mode 100644index 5aef921ee..000000000--- a/docs/docs/getting-started/requirements.md+++ /dev/null@@ -1,37 +0,0 @@-----sidebar_position: 4-title: Requirements------# System Requirements--Before installing and running Arcane, please ensure your system meets the following requirements.--## Runtime Requirements--These are needed to run Arcane itself.--- **Docker Engine:**- - Version **20.10.0** or higher is recommended.- - Arcane needs access to the Docker daemon socket (e.g., `/var/run/docker.sock`) or a TCP endpoint.-- **Operating System:** Any operating system capable of running Docker:- - Linux (Recommended)- - macOS- - Windows (with WSL2 recommended for best performance)-- **Web Browser:** A modern web browser is required to access the Arcane UI:- - Google Chrome (latest versions)- - Mozilla Firefox (latest versions)- - Safari (latest versions)- - Microsoft Edge (latest versions)-- **Hardware:**- - **RAM:** Minimum 512MB available for the Arcane container (actual usage may be lower). More RAM may be needed depending on the number of containers managed.- - **CPU:** 1 CPU core should be sufficient for Arcane itself.--## Installation Requirements (Recommended Method)--If you plan to use the recommended Docker Compose setup:--- **Docker Compose:** Version 1.29.0 or higher.-- **Git:** Required to clone the Arcane repository.--Meeting these requirements will ensure a smooth installation and optimal performance of Arcane.diff --git a/docs/docs/intro.md b/docs/docs/intro.mdindex de92c20c1..ab95ce4a8 100644--- a/docs/docs/intro.md+++ b/docs/docs/intro.md@@ -22,7 +22,7 @@ Arcane is a **Simple and Elegant Docker Management UI** written in Typescript an## Getting Started-To get started with Arcane, head over to the **[Installation](./getting-started/installation)** guide.+To get started with Arcane, head over to the **[Quickstart](./getting-started/quickstart)** guide.<div style={{display: 'flex',