Obscreen Docs

Appearance

Using Obscreen Offline ​

Restricted feature

This feature is available on-demand only

Installation ​

To start Obscreen in offline mode, you will need to start an additional server. It acts as a license server but locally runs on your device on port 49495. An internet connection is required for the first activation of the software to convert your license to an offline license. A new license file will be automatically updated.

No internet at all ?

Follow offline first activation section after installation.

> 🐧 Install on Linux ​

For Linux users, you can install all the dependencies and the studio with the following script:

bash
curl -fsSL https://raw.githubusercontent.com/obscreen/obscreen-offline-launcher/refs/heads/main/install-offline-launcher.sh -o /tmp/install-offline-launcher.sh && chmod +x /tmp/install-offline-launcher.sh && sudo /bin/bash /tmp/install-offline-launcher.sh $USER $HOME

To see logs you can use: sudo journalctl -u obscreen-offline-launcher -f

Auto restart obscreen-offline-launcher ​

To avoid restarting the server each time you restart your obscreen instance, you can add the following line to your docker-compose.yml file:

yaml
services:
  obscreen:
    image: obscreen/obscreen:latest
    # other configurations like ports, volumes, etc.
    entrypoint: ["obscreen-global-launcher.sh"]

Then add a obscreen-global-launcher.sh file next to your docker-compose.yml file with the following content:

  1. Create the file if it doesn't exist
bash
touch obscreen-global-launcher.sh
chmod +x obscreen-global-launcher.sh
  1. Add the following content to the file:
bash
#!/bin/bash
echo "Obscreen container started, triggering systemctl restart for obscreen-offline-launcher..."
sudo systemctl restart obscreen-offline-launcher
exec "$@"

Now each time you start your obscreen container, the obscreen-offline-launcher service will be restarted automatically.

> 🪟 Install on Windows ​

For Windows, you have to install the server manually by downloading the latest release from here.

> 🍏 Install on MacOS ​

For MacOS, you have to install the server manually by downloading the latest release from here.

How to use ​

Just start the server as a python script and Obscreen will automatically detect it.

WARNING

⚠️ You must restart obscreen-offline-launcher service each time you restart your obscreen instance.

Upgrade ​

There is no automatic upgrade for this. You'll have to do download and install the latest version manually.

  1. Re-install (use section from above)
  1. Restart the server
  • Linux: sudo systemctl restart obscreen-offline-launcher
  • Windows: Restart your server manually
  • MacOS: Restart your server manually

Offline first activation ​

If you have no internet connection, you'll need to manually setup the server.

  1. After installation, run the server in print mode using: python3 obscreen-offline-launcher.py --print
  2. You should see a message like this:
txt
----- Copy next line -----
eyJzeXNuIjogImRhcndpbiIsICJzeXNpIjogIjA3NzNlMTZkYWJjYjk0YTRiMzMzOTcwZGYzNDk2OWRiYjlhNzVkMzU0ZTcyNjk2MjQ3MzEwMGEzZjIxYWFmYmQiLCAibmlkIjogIjgyOGE4YmExMGQ5YzJiYTQ5MzkxMGJmZWU2NmJkZTMzZWJlZmQyZGRjNWZlZDNmODQ4NDdmMjk1YzI1N2ZkNjIifQ==
--------------------------
  1. Copy only the text between lines
  2. Go to your License Dashboard and click on the gear icon of your license
  3. Go to Paired device section, paste the text on the text field then click on Pair button.
  4. Download your updated license file by clicking on Download the license file button and put it on your Obscreen instance folder.
  5. Restart your obscreen instance and obscreen offline launcher service.

You should now be able to start Obscreen offline.

WARNING

⚠️ You must restart obscreen-offline-launcher service each time you restart your obscreen instance.

Switching between online and offline modes ​

Just contact us if you need to make the switch.