Skip to content

Latest commit

 

History

History
107 lines (83 loc) · 7.21 KB

README-engVer.md

File metadata and controls

107 lines (83 loc) · 7.21 KB
Raw

VanManga

VanLogo

Brands

Preview

VanManga is a lightweight, feature rich, manga crawling server. This application is designed to crawl and manage manga resources from manga source, enabling functions such as manga reading and backup.

What VanManga can do?

  1. 🔍 Searching manga from web. Enter the manga name in search box, you will get top 10 results from source website. Than you can select and download whatever you want.
  2. ⚠️ Management of manga. To ensure a diverse yet non-redundant collection of manga resources, when submitting a download request to the server, it will examine locally stored similar resources and, if necessary, provide users with confirmation options.
  3. 📋 Downloading queue. All downloading tasks will be added in a task queue and waiting for executing.
  4. 🔄 Daily check for manga updating Manga server will execute a checking task every day for updating downloaded manga if they are updated by source website.
  5. 🖥️ Dashboard monitoring downloading. You can check dashboard tab to view downloading progress of manga, it will show and update the latest episode name dynamically which have been downloaded and manga status in server with WebSocket.
  6. 🗃️ Re-zip all manga files. If you need to re-zip your local manga files, server provides a function to check and re-zip local files in order to reduce storage consumption.
  7. 🔧 Re-downloading single chapter. Sometimes due to the unstable web connection, some chapters will download failed. Now you can use re-downloading function to fix broken image in single chapter of mangas
  8. And maybe more in the future!

How to Install?

Currently, this project is available for local deployment through Docker Hub. So you can run your local VanManga server with customized HTTP port.

  1. Please ensure you have installed Docker in your system. On Windows or MacOS, we recommend you to install Docker Desktop to experience easier deployment. If you use Linux, feel free to use command line to do it.
  2. After installing Docker, please use this following command to get the latest version of VanManga in Docker: 
    docker pull wzl778633/vanislord_manga:latest
  3. To run your Docker container correctly, you need to set up environment variables \ volumes \ port:
    • Environment variables

      PYTHONUNBUFFERED: used for printing server log in Docker container, default is 1
      MANGA_BASE_URL: URL which you use to connect backend, default is http://localhost:5000. If you are using bridge in your Docker, you should change 'localhost' to your bridge internal IP.
      MANGA_BASE_WEBSOCKET_URL: URL which you expose to external, this is used for WebSocket services, default is http://localhost:5000.

    • Volumes

      { local path to manga lib } <==> /downloaded
      { local path to config files } <==> /vanmanga/eng_config

    • Port

      5000:5000 /_ or any port you want _/ You can use following command directly, or set up above variables in Docker Desktop GUI:

    docker run --name /*Your container name*/ \
-e PYTHONUNBUFFERED=1 \
-e MANGA_BASE_URL=http://localhost:5000  \
-e MANGA_BASE_WEBSOCKET_URL=http://localhost:5000  \
--mount type=bind,source=/*local machine address to manga lib*/,target=/downloaded \
--mount type=bind,source=/*local machine address to config file*/,target=/vanmanga/eng_config \
-p 5000:5000
wzl778633/vanislord_manga:latest
  4. Once container is running, server will start initialization automatically. You can see the process of initialization inside Docker container's logs.
    • The purpose of this initialization is to scan your existing manga_library.json and add all your existing manga information to the server and check the update.

How to use?

  1. Searching Manga
    We are using DogeManga as source.
    Enter manga name which you want to download in search box. It will show the top 10 related result in the browser. Caution: We will warn you if we detected you are adding mangas which may exist in the library based on name.
    s1
    s2

  2. Downloading Manga
    Select any mangas in searching results, after a short confirmation it will initiate downloading task. Currently, we will download all the chapters inside this manga(including volumes, specials, extras ...). s3
    s4

  3. Manga Lib Dashboard
    All the mangas you downloaded can be found in this dashboard. You can see the current status for each manga(E.g. Downloading / Queuing / Completed ...).
    Currently, dashboard only shows the latest chapter name which have been downloaded for you to track the status from each manga. s4 5 s5

  4. Re-downloading
    For each manga if you found any (chapter / volume / ... etc.). is broken during you reading. You can simply request re-download to that specific (chapter / volume / ... etc.). s6 s7 s8

  5. Reading
    Currently, our file structure is built to support Kavita. We highly recommend you to use it as your manga server. You can easily manage your manga files with its Web GUI and read with its reader. It also provides support to Paperback for IOS devices and Mihon for Android. You can find useful guides for setup below.

    But feel free to use any manga server you prefer if you don't like Kavita!

Demo

//ToDo

Contributing

Contributors

Currently, 2 main contributors are working for this project. Tom "Van" Wang & Kun "Alen" Qi

We will welcome any contribution for this project!

License

MIT