Create README.md

This commit is contained in:
Morgan 2023-10-10 00:20:37 +09:00 committed by GitHub
parent dfa21385f3
commit 16dd38ad22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions

12
README.md Normal file
View File

@ -0,0 +1,12 @@
## PAWE.ME
Simple mirroring & archiving server.
- This script is used to serve ![pawe.me](https://pawe.me) mirroring server.
- config.yaml contains various config options, can add more repo/upstream with just adding to config. supports http, rsync, ftpsync(debian).
- ~~HTTP Mirroring uses custom python script using aiohttp, may change to wget recursive mirroring..~~ fixing script, currently just fetches in order.
- $BASE_DIR is where all data is stored. Need to change manually in script index.py
- index.py renders index.html file after each sync, order and half-size card can be configured in config.yml