update name
This commit is contained in:
Raven Scott
parent
faa225c077
commit
0bfb29c6ff
26
README.md
26
README.md
@ -1,8 +1,8 @@
|
||||
# Peartainer
|
||||
# peardock
|
||||
|
||||
## Overview
|
||||
|
||||
Peartainer is a decentralized, peer-to-peer application designed to streamline Docker container management using Hyperswarm. The application connects multiple peers over a distributed hash table (DHT) network and provides full control over Docker containers, including starting, stopping, removing, duplicating, viewing logs, deploying from templates, and monitoring real-time metrics. With its robust server key-based architecture, Peartainer ensures secure and persistent peer-to-peer communication.
|
||||
peardock is a decentralized, peer-to-peer application designed to streamline Docker container management using Hyperswarm. The application connects multiple peers over a distributed hash table (DHT) network and provides full control over Docker containers, including starting, stopping, removing, duplicating, viewing logs, deploying from templates, and monitoring real-time metrics. With its robust server key-based architecture, peardock ensures secure and persistent peer-to-peer communication.
|
||||
|
||||
The **server key** forms the foundation of the connection. It is automatically generated, saved, and reused unless explicitly refreshed, making it easy to maintain consistent access while allowing for manual key regeneration when needed.
|
||||
|
||||
@ -166,8 +166,8 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
1. **Clone the Repository**:
|
||||
```bash
|
||||
git clone https://git.ssh.surf/snxraven/peartainer.git
|
||||
cd peartainer
|
||||
git clone https://git.ssh.surf/snxraven/peardock.git
|
||||
cd peardock
|
||||
```
|
||||
|
||||
2. **Change to Server Directory**:
|
||||
@ -249,7 +249,7 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
### Welcome Screen
|
||||
|
||||
|
||||
|
||||
|
||||
*The initial welcome screen guiding users to add a connection.*
|
||||
|
||||
@ -257,7 +257,7 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
### Container List
|
||||
|
||||
|
||||
|
||||
|
||||
*Displaying all Docker containers with real-time stats and action buttons.*
|
||||
|
||||
@ -265,7 +265,7 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
### Template Deployments
|
||||
|
||||
|
||||
|
||||
|
||||
*Browsing and selecting templates for deployment from a remote repository.*
|
||||
|
||||
@ -273,7 +273,7 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
### Final Deploy Modal
|
||||
|
||||
|
||||
|
||||
|
||||
*Customizing deployment parameters before launching a new container.*
|
||||
|
||||
@ -281,7 +281,7 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
### Duplicate Container Form
|
||||
|
||||
|
||||
|
||||
|
||||
*Duplicating an existing container with options to modify configurations.*
|
||||
|
||||
@ -289,7 +289,7 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
### Container Logs
|
||||
|
||||
|
||||
|
||||
|
||||
*Viewing real-time logs of a container directly from the UI.*
|
||||
|
||||
@ -329,7 +329,7 @@ The server interacts with Docker using **Dockerode**:
|
||||
|
||||
- The `SERVER_KEY` is sensitive and should be stored securely.
|
||||
- Refresh the key periodically to enhance security, especially in untrusted environments.
|
||||
- Peartainer uses encrypted peer-to-peer connections, but it's recommended to run it within secure networks.
|
||||
- peardock uses encrypted peer-to-peer connections, but it's recommended to run it within secure networks.
|
||||
- Limit access to the server by controlling who has the `SERVER_KEY`.
|
||||
|
||||
---
|
||||
@ -369,7 +369,7 @@ Contributions are welcome! Fork the repository, make your changes, and submit a
|
||||
|
||||
2. **Clone Your Fork**:
|
||||
```bash
|
||||
git clone https://github.com/your-username/peartainer.git
|
||||
git clone https://github.com/your-username/peardock.git
|
||||
```
|
||||
|
||||
3. **Create a Branch for Your Feature**:
|
||||
@ -403,4 +403,4 @@ Contributions are welcome! Fork the repository, make your changes, and submit a
|
||||
|
||||
## Contact
|
||||
|
||||
For questions, issues, or suggestions, please open an issue on the [GitHub repository](https://git.ssh.surf/snxraven/peartainer).
|
||||
For questions, issues, or suggestions, please open an issue on the [GitHub repository](https://git.ssh.surf/snxraven/peardock).
|
||||
@ -466,7 +466,7 @@
|
||||
|
||||
<div id="content">
|
||||
<div id="welcome-page">
|
||||
<h1>Welcome to Peartainer</h1>
|
||||
<h1>Welcome to peardock</h1>
|
||||
<p class="mt-3">Easily manage your Docker containers across peer-to-peer connections.</p>
|
||||
<p>To get started, add a connection using the form in the sidebar.</p>
|
||||
<!-- <img src="https://via.placeholder.com/500x300" alt="Welcome Graphic" class="img-fluid mt-4"> -->
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "peartainer",
|
||||
"name": "peardock",
|
||||
"main": "index.html",
|
||||
"pear": {
|
||||
"name": "peartainer",
|
||||
"name": "peardock",
|
||||
"type": "desktop",
|
||||
"gui": {
|
||||
"backgroundColor": "#1F2430",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user