- Warning
- if you are new to userver please start with quick start for beginners. This section is for opensourse userver development ONLY.
Usually there's no need to build userver itself. Refer to Configure, Build and Install section to make a service from a template and build it. If there's a strong need to build the userver and run its tests, then you have two options:
Local build
Download and extract the latest release from https://github.com/userver-framework/userver
git clone git@github.com:userver-framework/userver.git
cd userver
Install the build dependencies
Alternatively you could use a docker container with all the building dependencies installed from Docker.
Build userver:
mkdir build_debug
cd build_debug
# Adjust with flags from "Platform-specific build dependencies" section
cmake -S .. \
-DCMAKE_C_COMPILER=clang-18 \
-DCMAKE_CXX_COMPILER=clang++-18 \
-DCMAKE_BUILD_TYPE=Debug \
-DCPM_SOURCE_CACHE=~/cpm \
-DUSERVER_BUILD_ALL_COMPONENTS=1 \
-DUSERVER_BUILD_SAMPLES=1 \
-DUSERVER_BUILD_TESTS=1
cmake --build . -j$(nproc)
- See also
- cmake_options
- Run tests via
ulimit -n 4096 && ctest -V
If you need to edit or make your own docker image with custom configuration, read about it at scripts/docker/Readme.md.
Dev Containers
Dev Containers is the easiest way to build userver itself with all dependencies preinstalled using VSCode or CLion.
Download and extract the latest release from https://github.com/userver-framework/userver.
git clone git@github.com:userver-framework/userver.git
cd userver
- Install Docker
- Install IDE extension
- VSCode:
ms-vscode-remote.remote-containers;
- CLion: "Dev Containers" (note: beta).
- Open the userver project
- If CMake asks to configure, deny;
- For CLion, please use JetBrains Gateway to open the project, otherwise CLion gets confused.
- Agree to reopen the project in a Dev Container.
- The Docker container for development will automatically be downloaded (~1.5GB, may take a while), unpacked and run using the config from
.devcontainer directory.
- CMake will prompt you to select a Kit. Run Scan, then press
Ctrl + Shift + P and type "CMake: Select a kit". Choose clang-18. After that, project configuration will begin.
- When project configuration is complete, you can open any source file. clangd will start indexing the entire project in the background, and after indexing is complete, you will have code navigation, find references, and other features available.
- To build userver, simply click the Build button in the IDE.
- To run the tests, execute in the build directory:
ulimit -n 4096 && ctest -V.
- (Optional) Share Git credentials with the container to perform VCS operations from the IDE.
