Skip to content

Commit d992575

Browse files
docs: Added README."en".md translation via https://github.com/dephraiim/translate-readme
1 parent e3a0b69 commit d992575

1 file changed

Lines changed: 80 additions & 29 deletions

File tree

README.en.md

Lines changed: 80 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
3232
- Run Pywebio as a sub-APP of FastAPI.
3333
- Rewritten the interfaces of Douyin and TikTok, thank you[@johnserf-seed](https://github.com/Johnserf-Seed)
34-
- The file download endpoint has been rewritten and now uses asynchronous file IO.
34+
- 重写了文件下载的端点,现在使用异步文件IO。
3535
- Annotations and demonstration values ​​were added to all endpoints.
3636
- Organize the project file structure.
3737

@@ -128,7 +128,7 @@ _Download prohibited videos, perform data analysis, download without watermark o
128128

129129
## 📦Call the parsing library (to be updated):
130130

131-
> 💡PyPi<https://pypi.org/project/douyin-tiktok-scraper/>
131+
> 💡PyPi:<https://pypi.org/project/douyin-tiktok-scraper/>
132132
133133
Install the parsing library:`pip install douyin-tiktok-scraper`
134134

@@ -149,7 +149,7 @@ asyncio.run(hybrid_parsing(url=input("Paste Douyin/TikTok/Bilibili share URL her
149149

150150
## 🗺️Supported submission formats:
151151

152-
> 💡Tip: Including but not limited to the following examples. If you encounter link parsing failure, please open a new one.[issue](https://github.com/Evil0ctal/Douyin_TikTok_Download_API/issues)
152+
> 💡Tip: Including but not limited to the following examples, if you encounter link parsing failure, please open a new one[issue](https://github.com/Evil0ctal/Douyin_TikTok_Download_API/issues)
153153
154154
- Kuaishou video link
155155

@@ -235,9 +235,9 @@ Online:<https://api.douyin.wtf/docs>
235235

236236
## 💻Deployment (Method 1 Linux)
237237

238-
> 💡Tip: It is best to deploy this project to a server in the United States, otherwise strange BUGs may occur.
238+
> 💡Tips: It is best to deploy this project to a server in the United States, otherwise strange BUGs may occur.
239239
240-
Recommended for everyone to use[Digitalocean](https://www.digitalocean.com/)servers, mainly because they are free.
240+
Recommended for everyone to use[Digitalocean](https://www.digitalocean.com/)server, because you can have sex for free.
241241

242242
Use my invitation link to sign up and you can get a $200 credit, and when you spend $25 on it, I can also get a $25 reward.
243243

@@ -247,61 +247,111 @@ My invitation link:
247247

248248
> Use script to deploy this project with one click
249249
250+
- This project provides a one-click deployment script that can quickly deploy this project on the server.
251+
- The script was tested on Ubuntu 20.04 LTS. Other systems may have problems. If there are any problems, please solve them yourself.
250252
- Download using wget command[install.sh](https://raw.githubusercontent.com/Evil0ctal/Douyin_TikTok_Download_API/main/bash/install.sh)to the server and run
251253

252254

253255
wget -O install.sh https://raw.githubusercontent.com/Evil0ctal/Douyin_TikTok_Download_API/main/bash/install.sh && sudo bash install.sh
254256

255257
> Start/stop service
256258
257-
- `systemctl start/stop Douyin_TikTok_Download_API.service`
259+
- Use the following commands to control running or stopping the service:
260+
- `sudo systemctl start Douyin_TikTok_Download_API.service`
261+
- `sudo systemctl stop Douyin_TikTok_Download_API.service`
258262

259263
> Turn on/off automatic operation at startup
260264
261-
- `systemctl enable/disable Douyin_TikTok_Download_API.service`
265+
- Use the following command to set the service to run automatically at boot or cancel automatic run at boot:
266+
- `sudo systemctl enable Douyin_TikTok_Download_API.service`
267+
- `sudo systemctl disable Douyin_TikTok_Download_API.service`
262268

263269
> Update project
264270
271+
- When the project is updated, ensure that the update script is executed in the virtual environment and all dependencies are updated. Enter the project bash directory and run update.sh:
265272
- `cd /www/wwwroot/Douyin_TikTok_Download_API/bash && sudo bash update.sh`
266273

267274
## 💽Deployment (Method 2 Docker)
268275

269-
> 💡Docker Image repo:[Docker Hub](https://hub.docker.com/repository/docker/evil0ctal/douyin_tiktok_download_api)
276+
> 💡Tip: Docker deployment is the simplest deployment method and is suitable for users who are not familiar with Linux. This method is suitable for ensuring environment consistency, isolation and quick setup.
277+
> Please use a server that can normally access Douyin or TikTok, otherwise strange BUG may occur.
270278
271-
- Install docker
279+
### Preparation
272280

273-
```yaml
274-
curl -fsSL get.docker.com -o get-docker.sh&&sh get-docker.sh &&systemctl enable docker&&systemctl start docker
275-
```
281+
Before you begin, make sure Docker is installed on your system. If you haven't installed Docker yet, you can install it from[Docker official website](https://www.docker.com/products/docker-desktop/)Download and install.
282+
283+
### Step 1: Pull the Docker image
276284

277-
- Just leave the config.ini and docker-compose.yml files
278-
- Run the command to let the container run in the background
285+
First, pull the latest Douyin_TikTok_Download_API image from Docker Hub.
279286

280-
```yaml
281-
docker-compose up -d
287+
```bash
288+
docker pull evil0ctal/douyin_tiktok_download_api:latest
282289
```
283290

284-
- View container logs
291+
Can be replaced if needed`latest`Label the specific version you need to deploy.
292+
293+
### Step 2: Run the Docker container
285294

286-
```yaml
287-
docker logs -f douyin_tiktok_download_api
295+
After pulling the image, you can start a container from this image. Here are the commands to run the container, including basic configuration:
296+
297+
```bash
298+
docker run -d --name douyin_tiktok_api -p 80:80 evil0ctal/douyin_tiktok_download_api
288299
```
289300

290-
- Delete container
301+
Each part of this command does the following:
302+
303+
- `-d`: Run the container in the background (detached mode).
304+
- `--name douyin_tiktok_api `: Name the container`douyin_tiktok_api `
305+
- `-p 80:80`: Map port 80 on the host to port 80 of the container. Adjust the port number based on your configuration or port availability.
306+
- `evil0ctal/douyin_tiktok_download_api`: The name of the Docker image to use.
291307

292-
```yaml
293-
docker rm -f douyin_tiktok_download_api
308+
### Step 3: Verify the container is running
309+
310+
Check if your container is running using the following command:
311+
312+
```bash
313+
docker ps
294314
```
295315

296-
- renew
316+
This will list all active containers. Find`douyin_tiktok_api `to confirm that it is functioning properly.
317+
318+
### Step 4: Access the App
319+
320+
Once the container is running, you should be able to pass`http://localhost`Or API client access Douyin_TikTok_Download_API. Adjust the URL if a different port is configured or accessed from a remote location.
321+
322+
### 可选:自定义Docker命令
297323

298-
```yaml
299-
docker-compose pull && docker-compose down && docker-compose up -d
324+
For more advanced deployments, you may wish to customize Docker commands to include environment variables, volume mounts for persistent data, or other Docker parameters. Here is an example:
325+
326+
```bash
327+
docker run -d --name douyin_tiktok_api -p 80:80 \
328+
-v /path/to/your/data:/data \
329+
-e MY_ENV_VAR=my_value \
330+
evil0ctal/douyin_tiktok_download_api
300331
```
301332

302-
## ❤️ Contributor
333+
- `-v /path/to/your/data:/data`: Change the`/path/to/your/data`Directory mounted to the container`/data`Directory for persisting or sharing data.
334+
- `-e MY_ENV_VAR=my_value`: Set environment variables within the container`MY_ENV_VAR`, whose value is`my_value`
335+
336+
### Configuration file modification
337+
338+
Most of the configuration of the project can be found in the following directories:`config.yaml`File modification:
339+
340+
- `/crawlers/douyin/web/config.yaml`
341+
- `/crawlers/tiktok/web/config.yaml`
342+
- `/crawlers/tiktok/app/config.yaml`
343+
344+
### Step 5: Stop and remove the container
303345

304-
[![](https://github.com/Evil0ctal.png?size=50)](https://github.com/Evil0ctal)[![](https://github.com/jw-star.png?size=50)](https://github.com/jw-star)[![](https://github.com/Jeffrey-deng.png?size=50)](https://github.com/Jeffrey-deng)[![](https://github.com/chris-ss.png?size=50)](https://github.com/chris-ss)[![](https://github.com/weixuan00.png?size=50)](https://github.com/weixuan00)[![](https://github.com/Tairraos.png?size=50)](https://github.com/Tairraos)
346+
When you need to stop and remove a container, use the following commands:
347+
348+
```bash
349+
# Stop
350+
docker stop douyin_tiktok_api
351+
352+
# Remove
353+
docker rm douyin_tiktok_api
354+
```
305355

306356
## 📸Screenshot
307357

@@ -339,7 +389,8 @@ Web main interface:
339389

340390
[![Star History Chart](https://api.star-history.com/svg?repos=Evil0ctal/Douyin_TikTok_Download_API&type=Timeline)](https://star-history.com/#Evil0ctal/Douyin_TikTok_Download_API&Timeline)
341391

342-
[MY License](https://github.com/Evil0ctal/Douyin_TikTok_Download_API/blob/Stable/LICENSE)
392+
[Apache-2.0 license](https://github.com/Evil0ctal/Douyin_TikTok_Download_API/blob/Stable/LICENSE)
343393

344394
> Start: 2021/11/06
345-
> GitHub:[@Evil0ctal](https://github.com/Evil0ctal)Contact:[Evil0ctal1985@gmail.com](mailto:Evil0ctal1985@gmail.com)
395+
396+
> GitHub:[@Evil0ctal](https://github.com/Evil0ctal)

0 commit comments

Comments
 (0)