Browse Source

docs: update README.md

master 3.1.1
Dnomd343 2 years ago
parent
commit
b79e899004
  1. 49
      README.md

49
README.md

@ -6,20 +6,34 @@
First of all, you must have a docker environment, if not you should [install docker](https://docs.docker.com/engine/install/) first. After completion, use the following command to start *AllTube*.
```
# add `-e TITLE=...` option can specify the website title
shell> docker run -dit -p 24488:80 --name alltube dnomd343/alltube
```bash
docker run -d --restart always --name alltube -p 24488:80 dnomd343/alltube
```
If necessary, you can use the following command to build the image yourself.
After the command is run, *Alltube* will work on `tcp/24488`, of course, this port can be arbitrary. We can also specify the working options of *Alltube* through environment variables, the following are built-in options.
```
shell> docker build -t alltube https://github.com/dnomd343/alltube_docker.git
+ `TITLE=...` :Specify the website title.
+ `REMUX=ON` :Merge best audio and best video.
+ `STREAM=ON` :Allow stream videos through server.
+ `CONVERT=ON` :Enabled audio conversion.
Here is an example:
```bash
docker run -d --restart always --name alltube \
--env TITLE="My Alltube Site" \
--env CONVERT=ON \
--env STREAM=ON \
--env REMUX=ON \
-p 24488:80 dnomd343/alltube
```
Next, configure your web server reverse proxy to `localhost:24488`, let's take *Nginx* as an example here.
```
```nginx
server {
listen 80;
server_name video.343.re; # your domain
@ -32,10 +46,29 @@ server {
ssl_certificate /etc/ssl/certs/343.re/fullchain.pem; # TLS certificate of your domain
ssl_certificate_key /etc/ssl/certs/343.re/privkey.pem; # TLS private key of your domain
location / {
proxy_set_header Host $http_host;
proxy_pass http://127.0.0.1:24488;
proxy_set_header Host $http_host;
proxy_set_header X-Forwarded-Proto $scheme;
}
}
```
Finally, use the `nginx -s reload` command to take effect, visit your domain name and enjoy it!
### Advanced
If necessary, you can use the following command to build the image yourself.
```bash
docker build -t alltube https://github.com/dnomd343/alltube-docker.git
```
Due to the stagnation of the [youtube-dl](https://github.com/ytdl-org/youtube-dl) update, currently we use the [yt-dlp](https://github.com/yt-dlp/yt-dlp) project, you can manually change `YTDLP` in the Dockerfile to specify the latest version.
If you don't need the conversion function, you can remove the installation of `ffmpeg`, which will reduce the image size to a certain extent.
In addition, the project supports multi-stage builds, using the `buildx` command will speed up the build process.
### License
MIT ©2023 [@dnomd343](https://github.com/dnomd343)

Loading…
Cancel
Save