ArthurB/venus
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add more to HTTPS protocol

Browse source
This commit is contained in:
Arthur Beck 2025-03-18 20:30:46 -05:00
parent 2b03779aa7
commit a636855716
No known key found for this signature in database
GPG key ID: ACE3D14F5CEF14BF
2 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
HTTPS.md
View file

@ -8,4 +8,12 @@ All paths used are relative to the path provided by the user.
## Pulling
To start out communication, the client will attempt to access the file `.venus/VERSION`. It will then verify that it supports the specified protocol and version, before getting `.venus/default/BRANCH` and `.venus/default/MOD`. It will then get the specified branch file and retrieve each mod, populating it's own `.venus/MOD_ORDER`. It will then apply each mod's object(s) to it's own local copy of the repo.
To start out communication, the client will attempt to access the file `.venus/VERSION`. It will then verify that it supports the specified protocol and version, before getting `.venus/default/BRANCH` and `.venus/default/MOD`. It will then get the specified branch file and retrieve each mod, populating it's own `.venus/MOD_ORDER`. It will then apply each mod's object(s) to it's own local copy of the repo. After this, it will get `.venus/branches/LIST` and loop through each branch, getting the branches, mods, and objects.
## Fetching
Similar to git, Venus supports fetching(the process by which mods are recieved but objects are not). In this scenario, all that is done is verifying that the server is still up with `.venus/VERSION` before getting the branch file, checking if the local branch is up-to-date, and if not, downloading the modules but not the objects.
## Pushing
Pushing is achieved by simply creating POST requests to the necessary files and using HTTP basic authentication with a user-provided username and password to change the files. To prevent race conditions, the server MUST lock modifications to a specific IP address plus username and password combination when the file `.venus/LOCK` is updated with any body, and unlocked after either a timeout of 5 seconds since the last request from this combination or the file `.venus/UNLOCK` is updated with any body.