Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions blueprints/deno-kv-litefs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ source_url: https://fly.io/docs/blueprints/deno-kv-litefs/
---

import LitefsSunsetSnippet from '/snippets/docs/litefs-sunset.mdx';
import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsSunsetSnippet />
<LitefsUnsupportedSnippet />
<LitefsAutostopSnippet />

## Problem

Expand Down
6 changes: 6 additions & 0 deletions laravel/advanced-guides/global-sqlite-litefs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ description: "Replicate a Laravel app's SQLite database across Fly.io Machines w
source_url: https://fly.io/docs/laravel/advanced-guides/global-sqlite-litefs/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsUnsupportedSnippet />
<LitefsAutostopSnippet />

This is a technology preview. ["LiteFS"](/litefs) is a `distributed file system` that enables you to sync SQLite data across instances of your application.

Read further on the official [LiteFS documentation](/litefs/getting-started-fly) and follow along a LiteFS-configured [sample Laravel repository here](https://github.com/fly-apps/fly-laravel-litefs).
Expand Down
4 changes: 4 additions & 0 deletions litefs/backup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: Backing up your cluster
source_url: https://fly.io/docs/litefs/backup/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

While LiteFS replicates data between nodes and supports failover, it does not
currently have a disaster recovery system in place in the event you lose your
entire cluster. These are some strategies you can use to reduce your risk of
Expand Down
2 changes: 2 additions & 0 deletions litefs/cloud-backups.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ source_url: https://fly.io/docs/litefs/cloud-backups/
---

import LitefsSunsetSnippet from '/snippets/docs/litefs-sunset.mdx';
import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsSunsetSnippet />
<LitefsUnsupportedSnippet />

The simplest way to implement disaster recovery for your LiteFS cluster is
to use Fly.io's LiteFS Cloud for backups. LiteFS Cloud provides reliable backup
Expand Down
2 changes: 2 additions & 0 deletions litefs/cloud-restore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ source_url: https://fly.io/docs/litefs/cloud-restore/
---

import LitefsSunsetSnippet from '/snippets/docs/litefs-sunset.mdx';
import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsSunsetSnippet />
<LitefsUnsupportedSnippet />

## Overview

Expand Down
4 changes: 4 additions & 0 deletions litefs/config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: LiteFS Config Reference
source_url: https://fly.io/docs/litefs/config/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

Most of the configuration options for LiteFS are set via a `litefs.yml` config
file. You can find a fully-commented version of [`litefs.yml`](https://github.com/superfly/litefs/blob/main/cmd/litefs/etc/litefs.yml)
in the LiteFS repository.
Expand Down
4 changes: 4 additions & 0 deletions litefs/disaster-recovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,12 @@ source_url: https://fly.io/docs/litefs/disaster-recovery/
---

import LitefsSunsetSnippet from '/snippets/docs/litefs-sunset.mdx';
import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsSunsetSnippet />
<LitefsUnsupportedSnippet />
<LitefsAutostopSnippet />

The biggest advantage of using LiteFS Cloud is that you have backups
to restore from in case of an unfortunate situation where you lose
Expand Down
4 changes: 4 additions & 0 deletions litefs/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: Reading the event stream
source_url: https://fly.io/docs/litefs/events/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

LiteFS provides mechanisms for reading the [replication position](/litefs/position) and
[current primary status](/litefs/primary) through the FUSE file system mount. However,
this involves polling the file system which has overhead and some delay.
Expand Down
4 changes: 4 additions & 0 deletions litefs/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: LiteFS Export Command
source_url: https://fly.io/docs/litefs/export/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

## Overview

The `export` command will download a SQLite database from a LiteFS cluster. If
Expand Down
4 changes: 4 additions & 0 deletions litefs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: LiteFS FAQ
source_url: https://fly.io/docs/litefs/faq/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

LiteFS aims to work like running a single-server SQLite application as much as
possible. However, since it is a distributed system, some things may work
differently than you expect. This page is meant to provide answers for commonly
Expand Down
4 changes: 4 additions & 0 deletions litefs/getting-started-docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Getting Started with LiteFS in Docker
source_url: https://fly.io/docs/litefs/getting-started-docker/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

## Overview

This guide will walk you through the steps of getting a LiteFS cluster up and
Expand Down
6 changes: 6 additions & 0 deletions litefs/getting-started-fly.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ description: "Set up a LiteFS cluster on Fly.io: install litefs, configure litef
source_url: https://fly.io/docs/litefs/getting-started-fly/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsUnsupportedSnippet />

## Overview

This guide will walk you through the steps of getting a LiteFS cluster up and
Expand Down Expand Up @@ -243,6 +248,7 @@ Refer to the [`litefs import`](/litefs/import) documentation for more details.
You should only interact with SQLite databases on LiteFS through
a SQLite client or through the `litefs` tooling.
<br/><br/>
<LitefsAutostopSnippet />
Do not use `cp` to copy a database into place.
</Warning>

Expand Down
4 changes: 4 additions & 0 deletions litefs/how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: How LiteFS Works
source_url: https://fly.io/docs/litefs/how-it-works/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

LiteFS is a distributed file system specifically built for replicating SQLite
databases. This allows each application node to have a full, local copy of the
database and respond to requests with minimal latency. LiteFS is built for high
Expand Down
4 changes: 4 additions & 0 deletions litefs/import.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: LiteFS Import Command
source_url: https://fly.io/docs/litefs/import/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

## Overview

The `import` command will upload a SQLite database to a LiteFS cluster. If the
Expand Down
8 changes: 5 additions & 3 deletions litefs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ description: "Replicate SQLite across nodes with LiteFS, a distributed file syst
source_url: https://fly.io/docs/litefs/
---

<Note>
**Important:** We are not able to provide support or guidance for this product. Use with caution. Do not combine LiteFS with autostop/autostart on Fly Machines. The Fly Proxy’s autoscaler can shut down or restart Machines without any awareness of LiteFS lease ownership or data freshness, which can result in a stale machine winning the lease and LiteFS discarding newer changes and LTX file data—risking rollback and data loss.
</Note>
import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsUnsupportedSnippet />
<LitefsAutostopSnippet />

LiteFS is a distributed file system that transparently replicates SQLite
databases. You can run your application like it's running against a local
Expand Down
4 changes: 4 additions & 0 deletions litefs/migrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ title: Running database migrations
source_url: https://fly.io/docs/litefs/migrations/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

## Overview

LiteFS is a single-writer system so only the primary node can write to the
Expand Down
4 changes: 4 additions & 0 deletions litefs/mount.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: LiteFS Mount Command
source_url: https://fly.io/docs/litefs/mount/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

## Overview

The `mount` command will mount a LiteFS directory via FUSE and begin communicating
Expand Down
4 changes: 4 additions & 0 deletions litefs/position.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ title: Tracking LiteFS replication position
source_url: https://fly.io/docs/litefs/position/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

Each database created in LiteFS maintains a position in their replication log.
The position is a combination of a monotonically incrementing transaction ID
(TXID) and a rolling checksum of the database contents.
Expand Down
4 changes: 4 additions & 0 deletions litefs/primary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: Determining the primary
source_url: https://fly.io/docs/litefs/primary/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

The LiteFS directory (typically `/litefs`) provides a `.primary` file that
applications can read to determine the current primary node. This file only
exists if the node is currently a replica _and_ it is connected to the primary
Expand Down
6 changes: 6 additions & 0 deletions litefs/proxy.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: Built-in HTTP Proxy
source_url: https://fly.io/docs/litefs/proxy/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsUnsupportedSnippet />
<LitefsAutostopSnippet />

## Overview

<Info>
Expand Down
4 changes: 4 additions & 0 deletions litefs/releases.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: Releases
source_url: https://fly.io/docs/litefs/releases/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

If you're running on a Linux VPS without Docker, or as an alternative to installing
from LiteFS Docker builds, you can download the latest
version from our [LiteFS releases page](https://github.com/superfly/litefs/releases).
Expand Down
4 changes: 4 additions & 0 deletions litefs/run.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebarTitle: Run Command
source_url: https://fly.io/docs/litefs/run/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';

<LitefsUnsupportedSnippet />

## Overview

The `run` command will execute the program listed after the double dash. It
Expand Down
6 changes: 6 additions & 0 deletions litefs/speedrun.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ title: 'Speedrun: Add LiteFS to your app'
source_url: https://fly.io/docs/litefs/speedrun/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsUnsupportedSnippet />
<LitefsAutostopSnippet />

This guide will get your app up and running with LiteFS on Fly.io as
fast as possible. If you run into any issues with this guide, or you'd like
some more details or a slower pace, check out the [Getting Started doc][] instead.
Expand Down
6 changes: 6 additions & 0 deletions rails/advanced-guides/litefs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ description: "Replicate a Rails app's SQLite database across regions with LiteFS
source_url: https://fly.io/docs/rails/advanced-guides/litefs/
---

import LitefsUnsupportedSnippet from '/snippets/docs/litefs-unsupported.mdx';
import LitefsAutostopSnippet from '/snippets/docs/litefs-autostop.mdx';

<LitefsUnsupportedSnippet />
<LitefsAutostopSnippet />

This is a technology preview. It shows how to do multi-region deployments
using Sqlite3 and Litefs. See [LiteFS - Distributed
SQLite](/litefs) for background.
Expand Down
5 changes: 5 additions & 0 deletions snippets/docs/litefs-autostop.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Warning>
**Don't use LiteFS with autostop/autostart on Fly Machines.**

The Fly Proxy can stop and restart Machines without knowing which Machine holds the LiteFS lease or has the latest data. This can allow a Machine with stale data to acquire the lease, causing LiteFS to discard newer changes and LTX files. The result can be a database rollback and permanent data loss.
</Warning>
3 changes: 3 additions & 0 deletions snippets/docs/litefs-unsupported.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Note>
**Important:** LiteFS is outside our [scope of support](/about/support#scope-of-support). We are not able to provide support or guidance for it. Use with caution.
</Note>
Loading