Building from Source¶

Follow these instructions to either build SWS project from the source or the HTML documentation.

Building project from source¶

If you want to build SWS from the source, all you need is a Rust 2021 Edition installed.

So make sure to install Rust 1.70.0 or newer (or nightly) along with the toolchain(s) of your preference.

Then clone the repository and use Cargo to build the project from the source.

git clone https://github.com/static-web-server/static-web-server.git
cd static-web-server
cargo build --release

Finally, the release binary should be available at target/release/static-web-server or under your toolchain directory chosen.

Cargo features¶

When building from the source, all features are enabled by default. However, you can disable just the ones you don't need from the lists below.

Disable all default features¶

For example, if you want to run or build SWS without the default features like compression, http2, etc then just try:

# run
cargo run --no-default-features -- -h
# or build
cargo build --release --no-default-features

Cross-compiling¶

If you want to cross-compile SWS then consider using Zig as linker for easier cross compiling.

Let's say, you want to cross-compile SWS from macOS to Linux. Then follow these steps.

1. Add the necessary toolchain, for example just type: rustup target add x86_64-unknown-linux-gnu or rustup target add x86_64-unknown-linux-musl if a statically-linked binary is wanted.
2. Install the latest Zig version via brew install zig
3. Install cargo-zigbuild via cargo install cargo-zigbuild
4. Finally, build SWS as follows:

   # dynamically-linked binary
   cargo zigbuild --verbose --release --target=x86_64-unknown-linux-gnu
   # or statically-linked binary
   cargo zigbuild --verbose --release --target=x86_64-unknown-linux-musl
   

Built binaries can be found under the corresponding toolchain directory inside target/.

Building documentation from source¶

All HTML documentation is located in the docs/ project's directory and is built using Material for MkDocs.

It's only necessary to have Docker installed.

Building documentation¶

By default the docs will be built in the /tmp/docs directory, to do so follow these steps.

git clone https://github.com/static-web-server/static-web-server.git
cd static-web-server
mkdir /tmp/docs
docker run -it --rm \
    -v $PWD/docs:/docs \
    -v /tmp/docs:/tmp/docs squidfunk/mkdocs-material build

Development server¶

If you want to improve the documentation then run the built-in development server via docs/docker-compose.yml.

git clone https://github.com/static-web-server/static-web-server.git
cd static-web-server
docker-compose -f docs/docker-compose.yml up

Now the server will be available at localhost:8000