Updated documentation
This commit is contained in:
parent
1a63d04e64
commit
39078c1af2
@ -11,4 +11,4 @@ RUN curl -s -o go.mod https://raw.githubusercontent.com/animenotifier/notify.moe
|
|||||||
rm go.*
|
rm go.*
|
||||||
|
|
||||||
# Create empty working directory
|
# Create empty working directory
|
||||||
WORKDIR /host
|
WORKDIR /my
|
29
README.md
29
README.md
@ -6,31 +6,38 @@
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
* Install [Docker](https://www.docker.com/get-started) and [Compose](https://docs.docker.com/compose/install/)
|
* Install [Docker](https://www.docker.com/get-started)
|
||||||
|
* Install [Docker Compose](https://docs.docker.com/compose/install/)
|
||||||
|
|
||||||
## Clone the repository
|
## Setup
|
||||||
|
|
||||||
```bash
|
Download the developer image:
|
||||||
git clone https://github.com/animenotifier/notify.moe.git
|
|
||||||
```
|
|
||||||
|
|
||||||
## Download the dev image
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker pull animenotifier/notify.moe
|
docker pull animenotifier/notify.moe
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run the dev image
|
Run the developer image:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker-compose run notify.moe
|
docker-compose run notify.moe
|
||||||
```
|
```
|
||||||
|
|
||||||
## Run the server
|
## Usage
|
||||||
|
|
||||||
|
Your home directory is mounted as `/my` inside Docker. Usually you'd want to clone all repositories you use into a `projects` directory. This directory can be accessed by both your favourite editor on the host machine and also inside Docker.
|
||||||
|
|
||||||
|
* Clone notify.moe repository `git clone https://github.com/animenotifier/notify.moe.git`
|
||||||
|
* Enter notify.moe repository
|
||||||
* Compile TypeScript files using: `tsc`
|
* Compile TypeScript files using: `tsc`
|
||||||
* Start the web server in notify.moe directory using: `run`
|
* Compile template/style files using: `pack` (optional)
|
||||||
* In your browser, import the file `security/default/root.crt` as a trusted Root authority
|
* Start the web server using: `run`
|
||||||
|
|
||||||
|
The `run` binary is a development server that will restart the web server when it detects code changes.
|
||||||
|
|
||||||
|
## In your browser
|
||||||
|
|
||||||
|
* Import the file `security/default/root.crt` as a trusted Root authority
|
||||||
* Open `https://beta.notify.moe`
|
* Open `https://beta.notify.moe`
|
||||||
|
|
||||||
## Author
|
## Author
|
||||||
|
@ -5,6 +5,7 @@ services:
|
|||||||
context: .
|
context: .
|
||||||
network: host
|
network: host
|
||||||
image: animenotifier/notify.moe
|
image: animenotifier/notify.moe
|
||||||
|
hostname: docker
|
||||||
stdin_open: true
|
stdin_open: true
|
||||||
tty: true
|
tty: true
|
||||||
network_mode: host
|
network_mode: host
|
||||||
@ -12,4 +13,4 @@ services:
|
|||||||
- "80:4000"
|
- "80:4000"
|
||||||
- "443:4001"
|
- "443:4001"
|
||||||
volumes:
|
volumes:
|
||||||
- ~:/host
|
- ~:/my
|
Loading…
Reference in New Issue
Block a user