| Name | Name | Last commit date | ||
|---|---|---|---|---|
Continuing the legacy of Vanced
API server for ReVanced.
ReVanced API is a server that is used as the backend for ReVanced. ReVanced API acts as the data source for ReVanced Website and powers ReVanced Manager with updates and ReVanced Patches.
< 8000 div class="markdown-heading" dir="auto">Some of the features ReVanced API include:
ReVanced API can be deployed as a Docker container or used standalone.
To deploy ReVanced API as a Docker container, you can use Docker Compose or Docker CLI.
The Docker image is published on GitHub Container registry,
so before you can pull the image, you need
to authenticate to the Container registry.
.env file using .env.example as a templateconfiguration.toml file using configuration.example.toml as a templateabout.json file using about.example.json as a templatedocker-compose.yml file using docker-compose.example.yml as a templatedocker-compose up -d to start the server.env file using .env.example as a templateconfiguration.toml file using configuration.example.toml as a templateabout.json file using about.example.json as a templatedocker run -d --name revanced-api \
# Mount the .env file
-v $(pwd)/.env:/app/.env \
# Mount the configuration.toml file
-v $(pwd)/configuration.toml:/app/configuration.toml \
# Mount the patches public key
-v $(pwd)/patches-public-key.asc:/app/patches-public-key.asc \
# Mount the static folder
-v $(pwd)/static:/app/static \
# Mount the about.json file
-v $(pwd)/about.json:/app/about.json \
# Mount the persistence folder
-v $(pwd)/persistence:/app/persistence \
# Expose the port 8888
-p 8888:8888 \
# Use the start command to start the server
-e COMMAND=start \
# Pull the image from the GitHub Container registry
ghcr.io/revanced/revanced-api:latestTo deploy ReVanced API standalone, you can either use the pre-built executable or build it from source.
A Java Runtime Environment (JRE) must be installed.
.env file using .env.example as a templateconfiguration.toml file
using configuration.example.toml as a templateabout.json file using about.example.json as a templatejava -jar revanced-api.jar start to start the serverA Java Development Kit (JDK) and Git must be installed.
git clone git@github.com:ReVanced/revanced-api.git to clone the repository.env and fill in the required valuesconfiguration.toml and fill in the required valuesabout.json and fill in the required valuesgradlew run --args=start to start the serverThank you for considering contributing to ReVanced API. You can find the contribution guidelines here.
To build ReVanced API, a Java Development Kit (JDK) and Git must be installed.
Follow the steps below to build ReVanced API:
git clone git@github.com:ReVanced/revanced-api.git to clone the repositorygradlew build to build the projectReVanced API is licensed under the AGPLv3 licence. Please see the licence file for more information. tl;dr you may copy, distribute and modify ReVanced API as long as you track changes/dates in source files. Any modifications to ReVanced API must also be made available under the GPL along with build & install instructions.