puter-fuse

README

FUSE Driver for the Puter Internet OS

Access Puter's filesystem on your device

---

What does this do?

This program lets you mount your files from the Puter Open-Source Internet OS as though they were another harddrive. This works on Linux and Mac OS using the FUSE interface.

How to use

Make sure Go is installed. This has been tested on version go1.22.0.

Then, run this command to install puter-fuse:

go install github.com/HeyPuter/puter-fuse@latest

Configuration

First-time Configuration

The first-time configuration will ask you for your Puter username and password. If you don't have an account on puter.com you'll need one in order to use this FUSE driver. Note that once we release the open-source Puter Kernel you'll be able to login to any instance of that instead.

Entering your username and password, and accepting the default options for all other questions, should be sufficient for most installations.

Configuration file

Configuration is saved to:

• On Linux and Mac OS, $HOME/.config/puterfuse/config.json
• On Windows, %AppData%/puterfuse/config.json

Technical Information

What's a FUSE?

Filesystem in USErspace (FUSE) is an interface for filesystem drivers that are loaded as userspace programs rather than in the kernel. It is available in most POSIX systems like Linux and Mac OS.

Puter's FUSE driver allows access to a cloud filesystem in a way that looks like an ordinary local filesystem.

Performance and Caching

Currently directory trees support read and write-back caching. The contents of files are not currently cached by default, but you can set experimental_cache to true in the configuration file to enable read and write-back caching for files.

Documentation

Overview

* Copyright (C) 2024 Puter Technologies Inc. * * This file is part of puter-fuse. * * puter-fuse is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>.

* Copyright (C) 2024 Puter Technologies Inc. * * This file is part of puter-fuse. * * puter-fuse is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>.

* Copyright (C) 2024 Puter Technologies Inc. * * This file is part of puter-fuse. * * puter-fuse is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>.

* Copyright (C) 2024 Puter Technologies Inc. * * This file is part of puter-fuse. * * puter-fuse is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <https://www.gnu.org/licenses/>.