Skip to content

Latest commit

 

History

History
95 lines (64 loc) · 4.69 KB

findmydeviceserver.md

File metadata and controls

95 lines (64 loc) · 4.69 KB

FindMyDeviceServer

The playbook can install and configure FindMyDeviceServer for you.

FindMyDeviceServer is the official server for FindMyDevice (FMD), which allows you to locate, ring, wipe and issue other commands to your Android device when it is lost.

See the project's documentation to learn what FindMyDeviceServer does and why it might be useful to you.

For details about configuring the Ansible role for FindMyDeviceServer, you can check them via:

Dependencies

This service requires the following other services:

Adjusting the playbook configuration

To enable this service, add the following configuration to your vars.yml file and re-run the installation process:

########################################################################
#                                                                      #
# findmydeviceserver                                                   #
#                                                                      #
########################################################################

findmydeviceserver_enabled: true

findmydeviceserver_hostname: fmd.example.com

########################################################################
#                                                                      #
# /findmydeviceserver                                                  #
#                                                                      #
########################################################################

Note: hosting FindMyDeviceServer under a subpath (by configuring the findmydeviceserver_path_prefix variable) does not seem to be possible due to FindMyDeviceServer's technical limitations.

Set the path for storing a database file on the host

For a persistent storage for a database file, you need to add a Docker volume to mount in the container to share it with the host machine.

To add the volume, prepare a directory on the host machine and add the following configuration to your vars.yml file:

findmydeviceserver_database_path: /path/on/the/host

Make sure permissions of the directory specified to /path/on/the/host.

Set a registration token (optional)

With the default setting, the instance will be public and open to registration by anyone.

To make it private and have it require a token for registration, set it by adding the following configuration to your vars.yml file. Make sure to replace YOUR_TOKEN_HERE with your own value. Generating a strong token (e.g. pwgen -s 64 1) is recommended.

findmydeviceserver_config_registrationtoken: YOUR_TOKEN_HERE

Usage

After running the command for installation, FindMyDeviceServer becomes available at the specified hostname like https://fmd.example.com.

See this section on the role's documentation for details about how to set up the client (FindMyDevice).

Note

As sending commands from FindMyDeviceServer to your device requires a UnifiedPush Distributor application, you might be interested in self-hosting a ntfy Push Server along with it.

Troubleshooting

See this section on the role's documentation for details.