This software repository powers the Mudlet Snapshot portal and functions required to enable more reliable and customized storage of Mudlet's various CI builds.
File uploads can be accomplished as follows:
curl --upload-file ./test.gz https://make.mudlet.org/snapshots/test.gz
-or-
wget --method PUT --body-file="./test.gz" "https://make.mudlet.org/snapshots/test.gz" -O - -q
Both will return a link similar to this:
https://make.mudlet.org/snapshots/9162c7/test.gz
With Authentication required:
curl -u user:pass --upload-file ./test.gz https://make.mudlet.org/snapshots/test.gz
-or-
wget --user=username --password=pass --method PUT --body-file="./test.gz" "https://make.mudlet.org/snapshots/test.gz" -O - -q
Additional Headers may also be sent with PUT requests:
Max-Days - Controls the expiration time of the uploaded file.
Max-Downloads - Controls expiration based on File Downloads as well as time, whichever happens first.
To test access to Snapshots use:
https://make.mudlet.org/snapshots/knock/
- Returns: Known
- Returns: Unknown - <IP>
CI Snapshots provides an endpoint at /json.php for fetching snapshot data as JSON.
To use the JSON data, send a GET request to https://make.mudlet.org/snapshots/json.php
All data available will be returned by default. Optional arguments can be supplied to filter the returned data.
Optional URL Parameters are:
prid-- a PR ID number from github.commitid-- a Commit ID from Git/Github.platform-- a string for the platform, which must be one of:windows,linux, ormacos
The requested JSON list will show only entries which have matching values.
CI Snapshots supports fetching Artifacts from Github Action Storage.
Use /github_artifacts.php to submit a fetch request. If successful, the endpoint will return a URL similarly to how PUT uploads work.
Required URL Parameters are:
id-- a github artifact ID number.unzip-- 0 to use the zip as-is, or 1 to extract a file from the zip.
When using unzip=1 parameter, the artifact zip must contain only one file. The filename stored in the zip is also used as the snapshot filename.
When using unzip=0 parameter, the snapshot filename is created using the artifact name json property and appending .zip to it.
Optional settings via Headers Max-Days and Max-Downloads are also supported by this endpoint.
Due to limitations in Github Actions and Artifacts storage, while a job is running associated artifacts cannot be downloaded.
To work around this, workflows can enqueue artifacts by name - assuming the artifact name is unique among other artifacts.
Usage of /gha_queue.php is the same as /github_artifacts.php with one exception.
The id parameter is replaced with an artifact_name parameter and must contain a unique Artifact name.
Example usage:
https://make.mudlet.org/snapshots/gha_queue.php?artifact_name=Mudlet-4.10.1-testing-pr1111-a770ad4d-linux-x64&unzip=1
Optional settings via Headers are also supported.
Note: Queue services require a separate cron job!
Note 2: This feature requires a OAuth token with the actions scope or a personal access token with the public_repos scope.
This software is powered by PHP and Apache with Mod_Rewrite. Internationalization requires Intl and gettext php support.
Most Apache configurations may disable PUT method requests by default, so we need to make some configuration changes to Apache (in Server or VirtualHost areas) in order to enable PUT method requests as well as configure our RewriteMap directive for mod_rewrite.
The required Apache Directives should be something similar to this:
RewriteMap allowed "txt:/path/to/ip_list"
<Limit GET POST HEAD PUT OPTIONS>
Require all granted
</Limit>
<LimitExcept GET POST HEAD PUT OPTIONS>
Require all denied
</LimitExcept>
Script PUT /path/to/put.php
Download and unpack or Clone the software into a PHP-Enabled server directory. Copy and rename the file config.exmaple.php to config.php and edit the configuration.
Likewise, copy the ip_list.example to ip_list and edit the tab-separated list data to suit your needs.
Ensure that you have created an .htaccess file and are using the directives found within .htaccess.example to enable the rewrite rules and other security controls.
The software will automatically create the required tables in the database. Simply navigate to the index with a web browser before using cron.php or attempting to PUT files.