spee.ch/README.md

268 lines
10 KiB
Markdown
Raw Normal View History

2018-02-24 03:07:28 +01:00
# Spee.ch
2018-08-01 19:38:00 +02:00
2018-12-04 17:35:59 +01:00
spee.ch provides a user-friendly, custom-designed, image and video hosting site backed by a decentralized network and
blockchain ([LBRY](https://lbry.tech/)). Via just a small set of config files, you can spin your an entire spee.ch site back up including assets.
2018-12-04 17:38:48 +01:00
![App GIF](https://spee.ch/e/speechgif.gif)
2018-12-04 17:35:59 +01:00
For a completely open, unrestricted example of a spee.ch site, check out https://www.spee.ch.
For a closed, custom-hosted and branded example, check out https://lbry.theantimedia.com/.
2017-03-29 19:28:35 +02:00
2018-11-30 17:26:58 +01:00
## Installation
2018-11-30 17:26:58 +01:00
### Ubuntu Step-by-Step
2018-11-30 17:26:58 +01:00
[Step-by-step Ubuntu Install Guide](./docs/ubuntuinstall.md)
2018-08-10 00:39:32 +02:00
2018-11-30 17:26:58 +01:00
### Full Instructions
2018-11-12 00:26:00 +01:00
#### Get some information ready:
* mysqlusername
* mysqlpassword
2018-12-09 05:11:10 +01:00
* domainname or 'http://localhost:3000'
2018-11-12 00:26:00 +01:00
* speechport = 3000
2018-11-30 17:26:58 +01:00
#### Install and Set Up Dependencies
2018-11-19 02:13:04 +01:00
* Firewall open ports
* 22
* 80
* 443
* 3333
* 4444
2018-11-12 00:26:00 +01:00
* [NodeJS](https://nodejs.org)
2018-12-09 05:11:10 +01:00
* [MySQL version 5.7 or higher](https://dev.mysql.com/doc/refman/8.0/en/installing.html)
2018-11-12 00:26:00 +01:00
* mysqlusername or root
* mysqlpassword
2018-12-09 05:11:10 +01:00
* Requires mysql_native_password plugin
2018-11-12 00:26:00 +01:00
```
mysql> `ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'yourpassword';`
```
* [lbrynet](https://github.com/lbryio/lbry) daemon
* run this as a service exposing ports 3333 and 4444
* _note_: once the daemon is running, issue commands in another terminal session (tmux) to retrieve an address for your wallet to recieve 5+ LBC credits (or join us in the [#speech discord channel](https://discord.gg/YjYbwhS) and we will send you a few)
* `./lbrynet commands` gets a list of commands
* `./lbrynet account_balance` gets your balance (initially 0.0)
* `./lbrynet address_list` gets addresses you can use to recieve LBC
* [FFmpeg](https://www.ffmpeg.org/download.html)
2018-11-19 02:13:04 +01:00
* Spee.ch (below)
* pm2 (optional) process manager such as pm2 to run speech server.js
* http proxy server e.g. caddy, nginx, or traefik, to forward 80/443 to speech port 3000
* _note: even running on http://localhost, you must redirect http or https to port 3000_
2018-11-12 00:26:00 +01:00
2018-11-30 17:26:58 +01:00
#### Clone spee.ch
2018-11-12 00:26:00 +01:00
* release version for stable production
```
$ git clone -b release https://github.com/lbryio/spee.ch.git
```
* master version for development
```
$ git clone https://github.com/lbryio/spee.ch.git
```
* your own fork for customization
#### Change directory into your project
```
$ cd spee.ch
```
#### Install node dependencies
```
$ npm install
```
#### Create the config files using the built-in CLI
2018-11-19 02:13:04 +01:00
Make sure lbrynet is running in the background before proceeding.
2018-11-12 00:26:00 +01:00
2018-11-12 19:53:29 +01:00
_note: If you are opt to run a local chainquery, such as from [lbry-docker/chainquery](https://github.com/lbryio/lbry-docker/tree/master/chainquery) you will need to specify connection details at this time in:_ ~/spee.ch/docs/setup/conf/speech/chainqueryConfig.json
2018-11-12 00:26:00 +01:00
```
$ npm run configure
```
#### Build & start the app
```
2019-01-18 07:32:45 +01:00
$ npm run build
2018-11-12 00:26:00 +01:00
$ npm run start
```
#### View in browser
2018-12-09 05:11:10 +01:00
* Visit [http://localhost:3000](http://localhost:3000) in your browser
2018-10-29 22:23:51 +01:00
#### Customize your app
2018-08-10 01:12:02 +02:00
2018-10-29 22:23:51 +01:00
Check out the [customization guide](https://github.com/lbryio/spee.ch/blob/readme-update/customize.md) to change your app's appearance and components
2018-08-01 19:25:35 +02:00
2018-08-10 00:50:51 +02:00
#### (optional) add custom components and update the styles
2018-08-01 19:25:35 +02:00
2018-11-30 17:26:58 +01:00
* Create custom components by creating React components in `site/custom/src/`
* Update or override the CSS by changing the files in `site/custom/scss`
2018-08-01 19:25:35 +02:00
2018-11-12 00:26:00 +01:00
#### (optional) install your own chainquery
Instructions are coming at [lbry-docker] to install your own chainquery instance using docker-compose. This will require 50GB of preferably SSD space and at least 10 minutes to download, possibly much longer.
2017-06-27 00:16:46 +02:00
## API
2018-08-11 00:22:02 +02:00
#### /api/claim/publish
method: `POST`
2018-08-11 00:13:35 +02:00
example:
```
curl -F 'name=MyPictureName' -F 'file=@/path/to/myPicture.jpeg' https://spee.ch/api/claim/publish
```
Parameters:
* `name` (required, must be unique across the instance)
2018-08-11 00:13:35 +02:00
* `file` (required) (must be type .mp4, .jpeg, .jpg, .gif, or .png)
* `nsfw` (optional)
* `license` (optional)
* `title` (optional)
* `description` (optional)
2018-10-29 22:23:51 +01:00
* `thumbnail` URL to thumbnail image, for .mp4 uploads only (optional)
2018-08-11 00:13:35 +02:00
* `channelName` channel to publish too (optional)
* `channelPassword` password for channel to publish too (optional, but required if `channelName` is provided)
response:
```
{
"success": <bool>,
"message": <string>,
"data": {
"name": <string>,
"claimId": <string>,
"url": <string>,
"showUrl": <string>,
"serveUrl": <string>,
"lbryTx": {
"claim_address": <string>,
"claim_id": <string>,
"fee": <number>,
"nout": <number>,
"tx": <string>,
"value": <number>
}
}
}
```
2018-10-29 22:23:51 +01:00
#### /api/claim/availability/:name
2018-08-11 00:22:02 +02:00
method: `GET`
2018-10-29 22:23:51 +01:00
example:
2018-08-11 00:13:35 +02:00
```
curl https://spee.ch/api/claim/availability/doitlive
```
response:
```
{
"success": <bool>, // `true` if spee.ch successfully checked the claim availability
"data": <bool>, // `true` if claim is available, false if it is not available
"message": <string> // human readable message of whether claim was available or not
}
```
2018-08-11 00:13:35 +02:00
## Contribute
2018-04-17 21:57:53 +02:00
### Stack
The spee.ch stack is MySQL, Express.js, Node.js, and React.js. Spee.ch also runs `lbrynet` on its server, and it uses the `lbrynet` API to make requests -- such as `publish`, `create_channel`, and `get` -- on the `LBRY` network.
2018-10-29 22:23:51 +01:00
Spee.ch also runs a sync tool, which decodes blocks from the `LBRY` blockchain as they are mined, and stores the information in MySQL. It stores all claims in the `Claims` table, and all channel claims in the `Certificates` table.
2018-08-01 19:38:00 +02:00
2018-07-27 21:39:09 +02:00
* server
* [MySQL](https://www.mysql.com/)
2018-10-29 22:23:51 +01:00
* [express](https://www.npmjs.com/package/express)
2018-07-27 21:39:09 +02:00
* [node](https://nodejs.org/)
* [lbry](https://github.com/lbryio/lbry)
* [FFmpeg](https://www.ffmpeg.org/)
2018-07-27 21:39:09 +02:00
* client
* [react](https://reactjs.org/)
2018-08-10 00:50:51 +02:00
* redux
* sagas
* scss
* handlebars
2018-10-29 22:23:51 +01:00
2018-08-10 00:39:32 +02:00
### Architecture
2018-11-12 00:26:00 +01:00
* `cli/` contains the code for the CLI tool. Running the tool will create `.json` config files and place them in the `site/config/` folder
* `configure.js` is the entry point for the CLI tool
2018-10-29 22:23:51 +01:00
* `cli/defaults/` holds default config files
* `cli/questions/` holds the questions that the CLI tool asks to build the config files
2018-08-10 00:39:32 +02:00
* `client/` contains all of the client code
* The client side of spee.ch uses `React` and `Redux`
* `client/src/index.js` is the entry point for the client side js. It checks for preloaded state, creates the store, and places the `<App />` component in the document.
* `client/src/app.js` holds the `<App />` component, which contains the routes for `react-router-dom`
* `client/src/` contains all of the JSX code for the app. When the app is built, the content of this folder is transpiled into the `client/build/` folder.
* The Redux code is broken up into `actions/` `reducers/` and `selectors/`
* The React components are broken up into `containers/` (components that pull props directly from the Redux store), `components/` ('dumb' components), and `pages/`
* spee.ch also uses sagas which are in the `sagas/` folders and `channels/`
* `client/scss/` contains the CSS for the project
2018-10-29 22:23:51 +01:00
*
2018-11-12 00:26:00 +01:00
* `site/custom` is a folder which can be used to override the default components in `client/`
2018-08-10 00:39:32 +02:00
* The folder structure mimics that of the `client/` folder
2018-11-12 00:26:00 +01:00
* to customize spee.ch, place your own components and scss in the `site/custom/src/` and `site/custom/scss` folders.
2018-10-29 22:23:51 +01:00
2018-08-10 00:39:32 +02:00
* `server/` contains all of the server code
* `index.js` is the entry point for the server. It creates the [express app](https://expressjs.com/), requires the routes, syncs the database, and starts the server listening on the `PORT` designated in the config files.
* `server/routes/` contains all of the routes for the express app
* `server/controllers/` contains all of the controllers for all of the routes
* `server/models/` contains all of the models which the app uses to interact with the `MySQL` database.
* Spee.ch uses the [sequelize](http://docs.sequelizejs.com/) ORM for communicating with the database.
2018-10-29 22:23:51 +01:00
2018-08-10 00:39:32 +02:00
* `tests/` holds the end-to-end tests for this project
* Spee.ch uses `mocha` with the `chai` assertion library
* unit tests are located inside the project in-line with the files being tested and are designated with a `xxxx.test.js` file name
2018-10-29 22:23:51 +01:00
2018-08-10 00:39:32 +02:00
### Tests
* This package uses `mocha` with `chai` for testing.
* Before running tests, create a `testingConfig.js` file in `devConfig/` by copying `testingConfig.example.js`
* To run tests:
* To run all tests, including those that require LBC (like publishing), simply run `npm test`
* To run only tests that do not require LBC, run `npm run test:no-lbc`
### URL formats
2018-11-30 17:26:58 +01:00
Spee.ch has a few types of URL formats that return different assets from the LBRY network. Below is a list of all possible URLs for the content on spee.ch. You can learn more about LBRY URLs [here](https://lbry.tech/resources/uri).
2018-08-10 00:39:32 +02:00
* retrieve the controlling `LBRY` claim:
* https://spee.ch/`claim`
* https://spee.ch/`claim`.`ext` (serve)
* retrieve a specific `LBRY` claim:
* https://spee.ch/`claim_id`/`claim`
* https://spee.ch/`claim_id`/`claim`.`ext` (serve)
* retrieve all contents for the controlling `LBRY` channel
* https://spee.ch/`@channel`
* a specific `LBRY` channel
* https://spee.ch/`@channel`:`channel_id`
* retrieve a specific claim within the controlling `LBRY` channel
* https://spee.ch/`@channel`/`claim`
* https://spee.ch/`@channel`/`claim`.`ext` (serve)
* retrieve a specific claim within a specific `LBRY` channel
* https://spee.ch/`@channel`:`channel_id`/`claim`
* https://spee.ch/`@channel`:`channel_id`/`claim`.`ext` (serve)
2018-10-29 22:23:51 +01:00
2018-11-30 17:26:58 +01:00
### Dependencies
2018-08-01 19:38:00 +02:00
2018-11-30 17:26:58 +01:00
Spee.ch depends on two other lbry technologies:
* [chainquery](https://github.com/lbryio/chainquery) - a normalized database of the blockchain data. We've provided credentials to use a public chainquery service. You can also install it on your own server to avoid being affected by the commons.
* [lbrynet](https://github.com/lbryio/lbry) - a daemon that handles your wallet and transactions.
2018-08-01 19:38:00 +02:00
2018-11-30 17:26:58 +01:00
### Bugs
If you find a bug or experience a problem, please report your issue here on GitHub and find us in the lbry discord!
2018-11-19 02:13:04 +01:00
## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
## Security
We take security seriously. Please contact security@lbry.io regarding any security issues. [Our GPG key is here](https://lbry.io/faq/gpg-key) if you need it.
## Contact
2019-01-23 00:26:47 +01:00
The primary contact for this project is [@jessopb](mailto:jessop@lbry.io).