-
-
-
+ 
+
+ 
+
](https://www.docker.com/)
+
+```shell
+docker run -d \
+ --name telegram-files \
+ --restart always \
+ -e APP_ENV=${APP_ENV:-prod} \
+ -e APP_ROOT=${APP_ROOT:-/app/data} \
+ -e TELEGRAM_API_ID=${TELEGRAM_API_ID} \
+ -e TELEGRAM_API_HASH=${TELEGRAM_API_HASH} \
+ -p 6543:80 \
+ -v ./data:/app/data \
+ ghcr.io/jarvis2f/telegram-files:latest
+```
+
+**Using `docker-compose`**
+
+Copy [docker-compose.yaml](docker-compose.yaml) to your project directory and run the following command:
+
+```sh
+docker-compose up -d
+```
+
+> **Important Note:** You should NOT expose the service to the public internet. Because the service is not secure.
+
+---
+
+## โจ๏ธ Development
+
### โ๏ธ Prerequisites
Before getting started with telegram-files, ensure your runtime environment meets the following requirements:
@@ -96,27 +138,12 @@ gradle build
docker build -t jarvis2f/telegram-files .
```
-### ๐ค Usage
-
-**Using `docker`**
- [](https://www.docker.com/)
-
-Copy [docker-compose.yaml](docker-compose.yaml) to your project directory and run the following command:
-
-```sh
-docker-compose up -d
-```
-
-> **Important Note:** You should NOT expose the service to the public internet. Because the service is not secure.
-
----
-
## ๐ Project Roadmap
-- [ ] **`Task 1`**: Improve Telegramโs login functionality.
-- [ ] **`Task 2`**: Support auto transfer files to other destinations.
-- [ ] **`Task 3`**: Automatically download files based on set rules.
-- [ ] **`Task 4`**: Download statistics and reports.
+- โ
**`Task 1`**: Automatically download files based on set rules.
+- โ
**`Task 2`**: Download statistics and reports.
+- โ๏ธ **`Task 3`**: Improve Telegramโs login functionality.
+- โ๏ธ **`Task 4`**: Support auto transfer files to other destinations.
---
@@ -178,5 +205,6 @@ refer to the [LICENSE](LICENSE) file.