OS.js is an open-source desktop implementation for your browser with a fully-fledged window manager, Application APIs, GUI toolkits and filesystem abstraction.
This is the OS.js base project that you can use as a template to make your own distributions, installations and do general development.
This is v3. For v2 (deprecated) see the
masterbranch.
Visit the official demo for a preview version. Please note that some features are disabled and might be outdated or unavailable at times.
Node 8 (or newer) and any modern web-browser.
OS.js runs on
localhost:8000by default.
You can run a demo using docker without checkout out any source-code:
docker run -p 8000:8000 osjs/osjs:v3
# Clone *only* the v3 branch
git clone -b v3 --single-branch https://github.com/os-js/OS.js.git
cd OS.js
# Install dependencies
npm install
# It's recommended that you keep your dependencies (including OS.js) up-to-date
npm update
# Optionally install extra packages:
# For a list of packages, see https://manual.os-js.org/v3/resource/official/
npm install --production @osjs/example-application
# Discover installed packages
npm run package:discover
# Build your client
npm run build
# Start serving
npm run serve
You can also build a Docker image yourself or use docker-compose:
cp .env.example .env
docker-compose up
- Become a Patreon
- Support on Open Collective
- Contribution Guide
See the Official Manuals for articles, tutorials and guides.