towk/makeshift
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

chore: added server root section to README

Browse source
This commit is contained in:
David Allen 2025-08-31 11:56:11 -06:00
parent 8e1fa3d2ab
commit c9f40e3857
Signed by: towk
GPG key ID: 0430CDBE22619155
1 changed files with 18 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -3,7 +3,7 @@
The `makeshift` tool is a service that serves files and CLI that downloads them with a couple of handy features baked-in. Although the CLI and server component function more like a glorified FTP, the power of this tool comes from the plugin system. For example, the file cobbler is built to run external plugins for more advanced processing files before serving them (e.g. fetching from a data source, rendering Jinja 2 templates, etc.). The `makeshift` tool is a service that serves files and CLI that downloads them with a couple of handy features baked-in. Although the CLI and server component function more like a glorified FTP, the power of this tool comes from the plugin system. For example, the file cobbler is built to run external plugins for more advanced processing files before serving them (e.g. fetching from a data source, rendering Jinja 2 templates, etc.).
## Building the Tool ## Building and Go!
The `makeshift` tool is built using standard `go` build tools. To get started, clone the project, download the dependencies, and build the project: The `makeshift` tool is built using standard `go` build tools. To get started, clone the project, download the dependencies, and build the project:
@ -121,6 +121,23 @@ makeshift download profile default
> [!NOTE] > [!NOTE]
> Although every command has a `curl` equivalent, it is better to use the CLI since it has other features such as extracting and remove archives after downloading and saving archives as files automatically. > Although every command has a `curl` equivalent, it is better to use the CLI since it has other features such as extracting and remove archives after downloading and saving archives as files automatically.
## Server Root Structure
The `makeshift` server serves files at the specified `--root` path (also set with `MAKESHIFT_ROOT` environment variable). The directory structure looks like the following by default with initializing with `makeshift init $MAKESHIFT_ROOT`.
```bash
├── data
├── plugins
└── profiles
```
Each directory holds specific files for different purposes:
- `data` - Stores any and all miscellaenous files and directories.
- `plugins` - Stores plugins defined in the ["Creating Plugins"](#creating-plugins) section.
- `profiles` - Stores profiles in JSON format as defined in the ["Creating Profiles"](#creating-profiles) section.
## Creating Plugins ## Creating Plugins
The `makeshift` tool defines a plugin as an interface that can be implemented and compiled. The `makeshift` tool defines a plugin as an interface that can be implemented and compiled.