lurkcoin-core/README.md

60 lines
1.8 KiB
Markdown
Raw Normal View History

2020-04-21 12:24:16 +02:00
# lurkcoin
2020-05-24 13:35:28 +02:00
This is the core code of the current release of
[lurkcoin](https://forum.minetest.net/viewtopic.php?f=9&t=22768).
2020-04-21 12:24:16 +02:00
2021-02-22 07:37:15 +01:00
## Installation
2020-04-21 12:24:16 +02:00
2021-02-22 07:37:15 +01:00
Make sure you have [Go](https://golang.org) 1.13 or later installed.
2020-04-21 12:24:16 +02:00
2021-02-22 07:43:53 +01:00
To run lurkcoin, you can compile the lurkcoin-core binary:
2021-02-22 07:37:15 +01:00
```
$ go get github.com/luk3yx/lurkcoin-core
$ lurkcoin-core /path/to/config.yaml
```
*If you get a command not found error, you may have to run
~/go/bin/lurkcoin-core instead.*
I advise against importing `github.com/luk3yx/lurkcoin-core` in your own Go
code, any functions or types can and will change in future releases.
## Restoring the database from a backup
```
$ go get github.com/luk3yx/lurkcoin-core/cmd/...
$ lurkcoin-restore-backup /path/to/config.yaml /path/to/backup.json
```
2021-02-22 07:26:15 +01:00
2020-04-21 12:24:16 +02:00
## Configuration
See config.yaml for a list of configuration options.
## Compilation flags
The following compilation flags are supported:
- `lurkcoin.disablebbolt`: Disables the bbolt database. If this flag is used,
bbolt does not need to be installed.
- `lurkcoin.disableplaintextdb`: Disables the plaintext database.
- `lurkcoin.disablev2api`: Disables version 2 of the API. This can also be
done at runtime in config.yaml.
## License
Copyright © 2020 by luk3yx
This program 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/>.