justin/linkwallet
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 36 Wiki Activity

Further documentation improvements

Browse Source
This commit is contained in:
Justin Hawkins 2022-05-28 19:54:29 +09:30
parent c924c3e590
commit f8c8f520af
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -26,16 +26,18 @@ A self-hosted bookmark database with full-text page content search.
## Docker ## Docker
* Copy the docker-compose.yml-sample to a directory somewhere * Copy the `docker-compose.yml-sample` to a directory somewhere
* Rename to docker-compose.yml and edit to your needs * Rename to `docker-compose.yml` and edit to your needs
* In most cases, you only need to change the path to the `/data`
mountpoint.
* Run `docker-compose up -d` * Run `docker-compose up -d`
## Binary ## Binary
* Download the appropriate binary from the releases page * Download the appropriate binary from the releases page
* Install somewhere on your system * Install somewhere on your system
* Run ./linkwallet -db-path xxxx.db where xxxx.db is the location * Run `./linkwallet -db-path /some/path/xxxx.db` where `/some/path/xxxx.db`
of your bookmarks database (will be created if it does not exist) is the location of your bookmarks database (will be created if it does not yet exist)
## Source ## Source
@ -55,7 +57,7 @@ on binary).
Change the port number by setting the PORT environment variable. Change the port number by setting the PORT environment variable.
If you put linkwallet on a separate machine, or behind a reverse proxy, If you put linkwallet on a separate machine, or behind a reverse proxy,
go into the config page and set the correct BaseURL, or the bookmarklets go into the config page and set the correct `BaseURL` parameter, or the bookmarklets
will not work. will not work.
# Roadmap # Roadmap