mirror of
https://github.com/pooneyy/1Panel-Appstore.git
synced 2026-03-29 01:04:59 +08:00
docs: Add English README (#2676)
This commit is contained in:
parent
6323c01a20
commit
990602ed9f
97
maddy-mail/README_en.md
Normal file
97
maddy-mail/README_en.md
Normal file
@ -0,0 +1,97 @@
|
||||
# User Guide
|
||||
|
||||
## 1. Prepare Domain Certificates
|
||||
|
||||
Prepare a domain certificate using tools like `acme.sh`, `certbot`, or manual upload. Modify the configurations as needed.
|
||||
|
||||
The certificate domain should correspond to the mail server's `MX` hostname, such as `mail.example.com`.
|
||||
|
||||
|
||||
## 2. Create Docker Volume
|
||||
```
|
||||
docker volume create maddydata
|
||||
```
|
||||
|
||||
## 3. Install the Application
|
||||
|
||||
Install the application from the app store.
|
||||
|
||||
The first installation may show an error and the container may not run properly due to missing certificate files.
|
||||
|
||||
Ignore the error and proceed to the next step.
|
||||
|
||||
|
||||
## 4. Place the Domain Certificate into the Volume
|
||||
|
||||
The default path for the volume is:`/var/lib/docker/volumes/maddydata/_data/`
|
||||
|
||||
```
|
||||
# Enter the volume path
|
||||
cd $(docker volume inspect maddydata --format '{{.Mountpoint}}')
|
||||
|
||||
# Create certificate folder
|
||||
mkdir -p tls
|
||||
```
|
||||
Upload the certificate and private key to the tls folder, and rename them as:
|
||||
- fullchain.pem
|
||||
- privkey.pem
|
||||
|
||||
Once the certificates are correctly uploaded, the container will automatically start running.
|
||||
|
||||
## 5. Configure DKIM DNS Records
|
||||
### 5.1 Retrieve DKIM Values
|
||||
|
||||
After the container starts running, check the path:`/var/lib/docker/volumes/maddydata/_data/dkim_keys`
|
||||
|
||||
You will find a file named like `example.com_default.dns`.
|
||||
|
||||
This file contains the required DKIM information.
|
||||
|
||||
- Make sure to modify the domain as needed.
|
||||
|
||||
To view the contents in the terminal:
|
||||
```
|
||||
cat /var/lib/docker/volumes/maddydata/_data/dkim_keys/example.com_default.dns
|
||||
```
|
||||
|
||||
Example output:
|
||||
```
|
||||
default._domainkey.example.org. TXT "v=DKIM1; k=ed25519; p=nAcUUozPlhc4VPhp7hZl+owES7j7OlEv0laaDEDBAqg="
|
||||
```
|
||||
|
||||
### 5.2 Set DNS TXT Record
|
||||
|
||||
Set the `DNS records` based on the retrieved information.
|
||||
|
||||
For example:
|
||||
Add a `TXT` record for `default._domainkey.example.com` with the value `v=DKIM1; k=ed25519; p=nAcUUozPlhc4VPhp7hZl+owES7j7OlEv0laaDEDBAqg=`.
|
||||
|
||||
## 6. Set DNS Records
|
||||
|
||||
- Ensure modifications as needed.
|
||||
|
||||
| Record Type | Domain | Value |
|
||||
|-------------| --- |-------------------------------------------------------------|
|
||||
| A | `mail.example.com` | `Server IPv4 Address` |
|
||||
| A | `example.com` | `Server IPv4 Address` |
|
||||
| AAAA | `mail.example.com` | `Server IPv4 Address (if available)` |
|
||||
| AAAA | `example.com` | `Server IPv4 Address (if available)` |
|
||||
| MX | `example.com` | `mail.example.com` |
|
||||
| TXT | `mail.example.com` | `v=spf1 mx ~all` |
|
||||
| TXT | `example.com` | `v=spf1 mx ~all` |
|
||||
| TXT | `_dmarc.example.com` | `v=DMARC1; p=quarantine; ruf=mailto:postmaster@example.com` |
|
||||
| TXT | `_mta-sts.example.com` | `v=STSv1; id=1` |
|
||||
| TXT | `_smtp._tls.example.com` | `v=TLSRPTv1;rua=mailto:postmaster@example.com` |
|
||||
|
||||
## 7. Create Sending Accounts
|
||||
|
||||
Access the container terminal via the `Containers` panel and execute the following commands:
|
||||
|
||||
- Ensure modifications as needed.
|
||||
|
||||
```
|
||||
maddy creds create postmaster@example.com
|
||||
|
||||
maddy imap-acct create postmaster@example.com
|
||||
```
|
||||
END
|
||||
15
mailserver/README_en.md
Normal file
15
mailserver/README_en.md
Normal file
@ -0,0 +1,15 @@
|
||||
# Create Email Account
|
||||
|
||||
1. Click the **`Containers`** menu on the left.
|
||||
2. On the right, click the **`Terminal`** button.
|
||||
3. Run the following command to create an email account:
|
||||
|
||||
```shell
|
||||
// Create email account:
|
||||
docker exec -ti <CONTAINER NAME> setup email add <NEW ADDRESS>
|
||||
docker exec -ti <CONTAINER_NAME> setup email add admin@example.com
|
||||
|
||||
# Mailserver
|
||||
|
||||
Mailserver is a production-ready, full-stack but simple containerized email server (SMTP, IMAP, LDAP, anti-spam, antivirus, etc.). It uses only configuration files and no SQL database. It is designed to be simple, versioned, easy to deploy and upgrade.
|
||||
|
||||
37
metabase/README_en.md
Normal file
37
metabase/README_en.md
Normal file
@ -0,0 +1,37 @@
|
||||
# Metabase
|
||||
|
||||
Metabase is an open-source platform for data analysis and visualization, offering a range of features to help users explore, analyze, and present data effectively.
|
||||
|
||||
## Main Features
|
||||
|
||||
- **Data Connectivity**:
|
||||
Supports integration with various data sources, including relational databases (e.g., MySQL, PostgreSQL, Oracle), NoSQL databases (e.g., MongoDB), cloud platforms (e.g., Amazon Redshift, Google BigQuery), and data file formats.
|
||||
|
||||
- **Data Querying**:
|
||||
Provides an intuitive graphical interface and SQL query support, enabling users to retrieve data effortlessly.
|
||||
|
||||
- **Data Visualization**:
|
||||
Offers multiple chart types such as bar charts, line charts, and pie charts, along with options for customizing chart styles and colors to effectively present data.
|
||||
|
||||
- **Interactive Dashboards**:
|
||||
Create interactive dashboards by combining multiple charts and query results, making it easier to understand trends and relationships within the data.
|
||||
|
||||
- **Automated Reporting**:
|
||||
Schedule and automate report generation to share insights with team members at regular intervals.
|
||||
|
||||
- **Permissions and Security**:
|
||||
Fine-grained access control ensures that sensitive data is only accessible to authorized users.
|
||||
|
||||
- **Questions and Answers**:
|
||||
Utilize Metabase's "Questions" feature to ask natural language queries, which are executed automatically to provide insights without needing SQL knowledge.
|
||||
|
||||
- **Smart Suggestions**:
|
||||
Offers intelligent query recommendations to help users build efficient and accurate queries quickly.
|
||||
|
||||
- **Data Export**:
|
||||
Export query results in formats like CSV, Excel, and image files for further analysis or sharing.
|
||||
|
||||
- **Plugins and Extensibility**:
|
||||
Supports plugins and extensions to add new features or connect to additional data sources as needed.
|
||||
|
||||
Metabase empowers teams to transform raw data into actionable insights, making it a valuable tool for businesses and organizations of all sizes.
|
||||
38
palworld-server-tool/README_en.md
Normal file
38
palworld-server-tool/README_en.md
Normal file
@ -0,0 +1,38 @@
|
||||
# Palworld Server Management Tool
|
||||
|
||||
**Manage dedicated Palworld servers with a visual interface and REST API.**
|
||||
|
||||
Features and Roadmap Based on `Level.sav` Save File Parsing:
|
||||
|
||||
- [x] Complete player data
|
||||
- [x] Player Pal data
|
||||
- [x] Guild data
|
||||
|
||||
Features Based on Official RCON Commands (Server-Only):
|
||||
|
||||
- [x] Retrieve server information
|
||||
- [x] View online player list
|
||||
- [x] Kick/ban players
|
||||
- [x] In-game broadcasting
|
||||
- [x] Smoothly shut down the server with broadcasted messages
|
||||
|
||||
This tool uses **bbolt** single-file storage to periodically fetch and store data from RCON and `Level.sav` files.
|
||||
|
||||
It provides a simple visual interface and REST API, making management and development easier.
|
||||
|
||||
Ensure that private server RCON is enabled by following the instructions in the [official guide](https://github.com/zaigie/palworld-server-tool?tab=readme-ov-file#%E5%A6%82%E4%BD%95%E5%BC%80%E5%90%AF%E7%A7%81%E6%9C%8D-rcon).
|
||||
|
||||
---
|
||||
|
||||
Notes on Save File Parsing
|
||||
|
||||
> Parsing the `Level.sav` save file temporarily requires a certain amount of system memory (1GB~3GB) for short periods (<20s). The memory is released after the task is completed. Ensure your server has sufficient memory. If not, consider the following alternatives:
|
||||
|
||||
1. Deploy the tool on a separate server.
|
||||
2. Use a local personal computer for deployment.
|
||||
3. Opt for either of the above when the game server's performance is insufficient.
|
||||
|
||||
By default, the **PST tool and the game server are assumed to run on the same physical machine**. For separate deployments, refer to the following resources:
|
||||
|
||||
- [PST-Agent Deployment Guide](https://github.com/zaigie/palworld-server-tool/blob/main/README.agent.md)
|
||||
- [Sync Save Files from k8s Pod](https://github.com/zaigie/palworld-server-tool?tab=readme-ov-file#%E4%BB%8E-k8s-pod-%E5%90%8C%E6%AD%A5%E5%AD%98%E6%A1%A3)
|
||||
5
palworld/README_en.md
Normal file
5
palworld/README_en.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Palworld
|
||||
|
||||
**Palworld** is an open-world survival crafting game developed by **Pocketpair**. The game underwent a closed network test from November 2 to November 5, 2023, and launched its Early Access version on January 18, 2024.
|
||||
|
||||
In the game, players can explore a vast world, collecting magical creatures called "Palus". These creatures can be sent to battle, build, farm, and even engage in industrial production.
|
||||
22
roundcube/README_en.md
Normal file
22
roundcube/README_en.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Roundcube
|
||||
|
||||
Roundcube is a web-based, multi-language IMAP email client that provides a modern, feature-rich solution for managing email via a browser. Written in PHP, it offers all the essential functionalities of a desktop email client in a lightweight and easily deployable package.
|
||||
|
||||
## Main Features
|
||||
|
||||
- **Modern Interface**: Roundcube features a clean, user-friendly interface designed for efficiency and ease of use.
|
||||
- **Full MIME and HTML Support**: Seamlessly send and receive emails with complex formatting and attachments.
|
||||
- **IMAP and SMTP Support**: Communicates with mail servers using industry-standard protocols.
|
||||
- **Rich Text Editor**: Compose emails with a built-in HTML editor for advanced formatting.
|
||||
- **Search and Filters**: Robust search capabilities and customizable email filtering rules.
|
||||
- **Address Book**: Includes an address book with import/export functionality.
|
||||
- **Plugins and Themes**: Extend functionalities with plugins and customize the interface with themes.
|
||||
- **Multi-User Support**: Perfect for shared hosting environments or organizational deployments.
|
||||
- **Internationalization**: Offers multi-language support for a global user base.
|
||||
|
||||
## Use Cases
|
||||
|
||||
- **Personal Hosting**: Ideal for individuals or businesses hosting their own mail servers.
|
||||
- **Web Hosting Services**: Widely used by hosting providers to offer webmail access as part of their service packages.
|
||||
|
||||
Roundcube is a popular choice for anyone seeking a reliable, open-source webmail solution that balances simplicity with advanced features.
|
||||
36
uptime-kuma/README_en.md
Normal file
36
uptime-kuma/README_en.md
Normal file
@ -0,0 +1,36 @@
|
||||
# Uptime Kuma
|
||||
|
||||
Uptime Kuma is an open-source server monitoring and status checking tool that helps you track the availability, performance, and health status of your servers.
|
||||
|
||||
## Main Features:
|
||||
|
||||
### Server Monitoring
|
||||
|
||||
- Monitor multiple servers, including web servers, database servers, and application servers.
|
||||
- Regularly sends requests to check server availability, logging response times and statuses for real-time insights.
|
||||
|
||||
### Custom Checks
|
||||
|
||||
- Configure custom monitoring rules tailored to your needs, such as checking specific ports or validating the presence of particular content.
|
||||
- Supports multiple protocols, including HTTP, TCP, and ICMP, to provide versatile monitoring options.
|
||||
|
||||
### Notifications and Alerts
|
||||
|
||||
- Set up notifications and alerts to be informed immediately when server issues occur.
|
||||
- Supports various notification methods, such as email, Slack, and webhooks.
|
||||
- Define thresholds for triggering alerts, such as downtime or exceeding response time limits.
|
||||
|
||||
### Historical Data and Reporting
|
||||
|
||||
- Keeps detailed logs of monitoring history, allowing you to review server performance and availability trends.
|
||||
- Generate periodic reports to analyze server status patterns and optimize performance.
|
||||
|
||||
### User-Friendly Interface
|
||||
|
||||
- Features an intuitive and visually appealing interface for easy setup and monitoring.
|
||||
- Offers multi-language support and customizable themes to meet user preferences.
|
||||
|
||||
### Open Source and Extensible
|
||||
|
||||
- As an open-source project, Uptime Kuma can be customized and extended to fit your specific requirements.
|
||||
- Backed by a vibrant community and active development, ensuring continuous updates and feature improvements.
|
||||
Loading…
x
Reference in New Issue
Block a user