Update aquatic_http_private/README.md

This commit is contained in:
Joakim Frostegård 2022-04-03 20:31:57 +02:00
parent 98e7e5cc13
commit 77c83d21a8

View file

@ -1,4 +1,6 @@
# aquatic_private
# aquatic_http_private
Work in progress.
## Setup
@ -17,7 +19,7 @@ Create stored procedure (`OR REPLACE` keeps privileges in place and is supported
CREATE OR REPLACE PROCEDURE aquatic_announce_v1 (
IN p_source_ip VARBINARY(16),
IN p_source_port SMALLINT UNSIGNED,
IN p_user_agent TEXT,
IN p_user_agent TEXT, -- Can be NULL
IN p_user_token VARCHAR(255),
IN p_info_hash CHAR(40),
IN p_peer_id CHAR(40),
@ -25,9 +27,9 @@ CREATE OR REPLACE PROCEDURE aquatic_announce_v1 (
IN p_uploaded BIGINT UNSIGNED,
IN p_downloaded BIGINT UNSIGNED,
IN p_left BIGINT UNSIGNED,
OUT p_announce_allowed BOOLEAN,
OUT p_failure_reason TEXT,
OUT p_warning_message TEXT
OUT p_announce_allowed BOOLEAN, -- false if not set
OUT p_failure_reason TEXT, -- NULL if not set
OUT p_warning_message TEXT -- NULL if not set
)
MODIFIES SQL DATA
BEGIN
@ -44,7 +46,5 @@ DATABASE_URL="mysql://aquatic:aquatic@localhost/aquatic"
Run application:
```sh
cargo run -p aquatic_http_private
```
Test by visiting `localhost:3000/announce/abcd/?info_hash=abcdeabcdeabcdeabcde&peer_id=abcdeabcdeabcdeabcde&port=1000&left=0`
cargo run --release -p aquatic_http_private
```