Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update feature-reference.md #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update feature-reference.md #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 8 additions & 8 deletions docs/user_guide/feature-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,37 +46,37 @@ Backups in Athens are stored in a `.bkp` format which is easy to restore from. T

Restoring from a `.bkp` file is a five-step process.

Locate your database folder
1. Locate your database folder

Backups in Athens are stored in your main DB folder and have a `.bkp` file extension. To locate your database folder, in the Athens app, click the database icon on the toolbar and you will see the current location of your database. In this folder, you will see your backup files.
Backups in Athens are stored in your main DB folder and have a `.bkp` file extension. To locate your database folder, in the Athens app, click the database icon on the toolbar and you will see the current location of your database. In this folder, you will see your backup files. Remember the location of this folder and close Athens.

![](/img/gitbook/image-4.png)

Relocate your `index.transit` file
2. Relocate your `index.transit` file

Before we proceed to the next step, locate your current `index.transit` file and relocate it to another folder.

![](/img/gitbook/123552515-160cc780-d794-11eb-961d-8c277b3f632e-1.gif)

Locate the backup file you want to restore from
3. Locate the backup file you want to restore from

Once you are in the folder, find a file with a creation time that corresponds to the state of your database you would like to revert to. For instance, let's say you want to restore my DB to where it was on the night of June 6th. In this case, you find a `.bkp` file with a creation time around that specific time. You can also use a [Unix time converter](https://time.is/Unix_time_converter) to figure out when Athens created a `.bkp` file.

Rename the backup file
4. Rename the backup file

At this point, rename the selected `.bkp` file to `index.transit`.

![](/img/gitbook/123552503-0ab99c00-d794-11eb-938a-14fe80200184.gif)

Open the new file in Athens
5. Open the new file in Athens

![](/img/gitbook/image-5.png)

Reopen Athens, click the database icon once again and make sure you are on the **Open** pane. Proceed to click the open button and navigate to the newly created \`index.transit\` file. You have now reverted to a backup! All new backups will be created from this file and changes made to your DB will also reflect in the new `index.transit` file.

Frequency of backups

You can set your desired backup and auto save frequency in the settings page. By default, Athens saves a copy of your database every 15 seconds into your main folder.
You can set your desired backup and auto save frequency in the settings page. By default, Athens saves a copy of your database 15 seconds after you make a change into your main folder.

Best practices

Expand All @@ -86,7 +86,7 @@ Additionally, because the backups are locally stored \(for the moment\), it make

## Import

To download a `.edn` file from Roam Research, visit your Roam graph and click on the three doc symbol **⋯** in the top bar, then **Export All**. Choose **EDN** from the Export Format dropdown, then click **Export All**.
To create a `.edn` file from Roam Research, visit your Roam graph and click on the three doc symbol **⋯** in the top bar, then **Export All**. Choose **EDN** from the Export Format dropdown, then click **Export All**.

You'll download a `.zip` file, which you need to open/extract the `.edn` file out of.

Expand Down