Skip to content

Commit

Permalink
add guinicord execution instruction to README
Browse files Browse the repository at this point in the history
  • Loading branch information
none committed Jan 8, 2024
1 parent de892f0 commit 280ea6c
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 3 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
The micro autoindex and file hosting server with one Flask framework dependence.
HTTP server that allow to download and upload files.

<a id="org58f5941"></a>

# Features:

Allow to transfer files between systems easily and safely.
Expand All @@ -24,6 +26,7 @@ Allow to transfer files between systems easily and safely.
- optional basic file type recognition: text, image, audio, video
- optional ability to prevent downloading of small files to use browser as a text reader.

<a id="org58f5941"></a>

# Dependencies

Expand All @@ -33,6 +36,8 @@ Flask >= 2.3.2

Lower version may work as well.

<a id="org0fa2131"></a>

# Usage

export FLASK_RUN_HOST=0.0.0.0 FLASK_RUN_PORT=8080
Expand All @@ -50,6 +55,10 @@ Here is defaults, that you can change:
export FLASK_FLASK_UPLOADING_ENABLED=True


Built-in web server is secure enough, but to execute with ``` pip install gunicorn ```

gunicorn micro_file_server.__main__:app

<a id="orgb47cec7"></a>

# Screenshot
Expand Down
2 changes: 1 addition & 1 deletion micro_file_server/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""Flask indexer and micro file server without dependencies."""

__version__ = "0.0.9"
__version__ = "0.1"
2 changes: 1 addition & 1 deletion micro_file_server/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
# Author: Anoncheg1
# Keywords: filesharing, fileserver, httpserver
# URL: https://github.com/Anoncheg1/pinyin-isearch
# Version: v0.0.9
# Version: 0.1
# Requires: Flask >= 2.3.2

# License:
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ build-backend = "hatchling.build"
[project]
name = "micro_file_server"
readme = "README.md"
version = "0.0.9"
version = "0.1"
authors = [
{ name="Anoncheg1" }
]
Expand Down

0 comments on commit 280ea6c

Please sign in to comment.