Skip to content

Commit 43a726b

Browse files
committed
Improve readme
1 parent f8eb4fe commit 43a726b

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ https://user-images.githubusercontent.com/2183313/139728539-d69b899f-6f9b-44cb-a
6363
- [Items are missing in my Collections / Search results](#items-are-missing-in-my-collections--search-results)
6464
- [I get a `failed to retrieve` error when opening](#i-get-a-failed-to-retrieve-error-when-opening)
6565
- [Can I embed AtomicServer in another application?](#can-i-embed-atomicserver-in-another-application)
66+
- [I want to use my own authorization. How do I do that?](#i-want-to-use-my-own-authorization-how-do-i-do-that)
6667
- [Where is my data stored on my machine?](#where-is-my-data-stored-on-my-machine)
6768
- [Also in this Repo](#also-in-this-repo)
6869
- [`atomic-cli`](#atomic-cli)
@@ -297,9 +298,10 @@ Also, read the [Atomic Data Docs](https://docs.atomicdata.dev/) to learn more ab
297298

298299
### Can / should I create backups?
299300

300-
You should. Especially before installing a newer AtomicServer version, as it might be imcompatible with the previous database model and could corrupt the database.
301-
Run `atomic-server export` to create a backup in your `~/.config/atomic/backups` folder.
302-
Import them using `atomic-server import -p ~/.config/atomic/backups/${date}.json`.
301+
You should.
302+
Run `atomic-server export` to create a JSON-AD backup in your `~/.config/atomic/backups` folder.
303+
Import them using `atomic-server import -p ~/.config/atomic/backups/${date}.json`.'
304+
You could also copy all folders `atomic-server` uses. To see what these are, see `atomic-server show-config`.
303305

304306
### I lost the key / secret to my Root Agent, and the `/setup` invite is no longer usable! What now?
305307

@@ -312,7 +314,7 @@ This could especially be helpful if you're running at `localhost:9883` and want
312314

313315
### How do I reset my database?
314316

315-
Remove the `db` folder in your `atomic` config: `rm -rf ~/.config/atomic/db`.
317+
`atomic-server reset`
316318

317319
### How do I make my data private, yet available online?
318320

@@ -334,6 +336,11 @@ Try re-initializing atomic server `atomic-server --initialize`.
334336
Yes. This is what I'm doing with the Tauri desktop distribution of AtomicServer.
335337
Check out the [`desktop`](https://github.com/atomicdata-dev/atomic-server/tree/master/desktop) code for an example!
336338

339+
## I want to use my own authorization. How do I do that?
340+
341+
You can disable all authorization using `--public-mode`.
342+
Make sure AtomicServer is not publicly accessible, because this will allow anyone to read any data.
343+
337344
### Where is my data stored on my machine?
338345

339346
It depends on your operating system, because some data is _temporary_, others are _configuration files_, and so forth. Run `atomic-server show-config` to see the used paths. You can overwrite these if you want, see `--help`.

0 commit comments

Comments
 (0)