aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAdam Soltys <[email protected]>2023-02-06 16:48:13 -0800
committerAdam Soltys <[email protected]>2023-02-06 16:48:13 -0800
commit9c667055c6367e1b2e239686e72f52995679a47e (patch)
tree0b1d4aee51ec2d4e92d08a9d1404ba4e2ecd462a /README.md
parent15294844dbc8e73b4d1e92008a7eebc6b86b9ec5 (diff)
parent6f5602d112b68adb7452abf3047f20c32e7725b6 (diff)
downloadcoinos-server-9c667055c6367e1b2e239686e72f52995679a47e.tar.gz
coinos-server-9c667055c6367e1b2e239686e72f52995679a47e.zip
Merge branch 'master' into test
Diffstat (limited to 'README.md')
-rw-r--r--README.md47
1 files changed, 6 insertions, 41 deletions
diff --git a/README.md b/README.md
index 699bd928..9215afae 100644
--- a/README.md
+++ b/README.md
@@ -1,49 +1,14 @@
-# coinos-server
+# Coinos
-Coinos is a bitcoin wallet app that supports payments over the <a href="https://bitcoin.org">bitcoin</a>, <a href="https://blockstream.com/liquid/">liquid</a> and <a href="http://lightning.network/">lightning</a> networks. Try it out at <a href="https://coinos.io/">coinos.io</a>.
+Coinos is a web-based bitcoin and nostr client. You can use it as a front end to your personal bitcoin and lightning nodes or host a public instance that allows anyone to register with a username and password. Try ours at https://coinos.io
-This repository contains the code for the backend API server which is implemented as a NodeJS application. The code for the frontend UI is tracked separately <a href="https://github.com/asoltys/coinos.io">here</a>.
+This repository contains the code for the API server. The frontend code is at <a href="https://github.com/coinos/coinos-ui">https://github.com/coinos/coinos-ui</a>
## Install
-The follow commands will set up bitcoin, liquid and lightning nodes in regtest mode, along with a coinos app server, database, and front end UI. You'll need to have <a href="https://docs.docker.com/get-docker/">docker</a> installed as a pre-requisite.
+Make sure you have <a href="https://docs.docker.com/get-docker/">docker</a> then run the setup script:
```bash
-git clone https://github.com/coinos/coinos-server
-cd coinos-server
-cp -r sampleconfig config
-cp -r sampledata data
-mkdir uploads
-sudo chown $(id -u):$(id -g) config/liquid
-sudo chown $(id -u):$(id -g) config/bitcoin
-cp .env.sample .env
-cp fx.sample fx
-docker network create net --gateway 172.18.0.1 --subnet 172.18.0.0/16
-docker run -it -v $(pwd):/app --entrypoint pnpm asoltys/coinos-server i
-docker-compose up -d
-docker exec -i maria mysql -u root -ppassword < db/schema.sql
-docker exec -it bitcoin bitcoin-cli createwallet coinos
-docker exec -it bitcoin bitcoin-cli rescanblockchain
-docker exec -it bitcoin bitcoin-cli generatetoaddress 500 $(docker exec -it bitcoin bitcoin-cli getnewaddress "" "p2sh-segwit")
-docker exec -it liquid elements-cli createwallet coinos
-docker exec -it liquid elements-cli rescanblockchain
-docker exec -it liquid elements-cli sendtoaddress AzpsKhC6xE9FEK4aWAzMnbvueMLiSa5ym1xpuYogFkHzWgMHSt8B79aNNbFppQzCSQ2yZ9E4nL6RQJU7 1000000
-docker exec -it liquid elements-cli generatetoaddress 1 AzpsKhC6xE9FEK4aWAzMnbvueMLiSa5ym1xpuYogFkHzWgMHSt8B79aNNbFppQzCSQ2yZ9E4nL6RQJU7
-curl localhost:3119/register -H "content-type: application/json" -d '{"user": { "username": "coinosfees", "password": "password"}}'
+chmod +x setup.sh
+./setup.sh
```
-
-After successful creation of all docker containers coinos ui will be available at http://localhost:8085 and coinos server will be available at http://localhost:3119
-
-### License
-
-This code is [licensed]. Coinos is free for personal use. Anyone can fork as long as it stays AGPLv3.
-
-To purchase a commercial license or to inquire about customized, managed instances - please reach out to us at [[email protected]]
-
-
-[Config changes]:(#config-changes)
-[config/lnd/lnd.conf]:./sampleconfig/lnd/lnd.conf
-[pwd file]:./sampleconfig/lnd/pwd
-[licensed]:./LICENSE.md
-[generate some BTC]:./doc/fund-server-bitcoin-cli.md