فهرست منبع

chore(Wiki): Backend commands doc and other updates

Owen Diffey 2 سال پیش
والد
کامیت
e80e0db182
3فایلهای تغییر یافته به همراه13 افزوده شده و 11 حذف شده
  1. 9 5
      .wiki/Backend_Commands.md
  2. 4 2
      .wiki/Installation.md
  3. 0 4
      README.md

+ 9 - 5
.wiki/Backend_Commands.md

@@ -5,11 +5,15 @@ Backend commands are inputted via STDIN or if using the Utility Script by using
 | Command | Parameters | Description |
 | --- | --- | --- |
 | `rs` | | Restart backend. |
-| `status` | | List all modules, their states, the jobs queued, running and paused, and the concurrency. |
-| `queued` | `module` | List all jobs queued for specified module. |
-| `running` | `module` | List all jobs running for specified module. |
-| `paused` | `module` | List all jobs paused for specified module. |
-| `jobinfo` | `UUID` | Get a detailed overview of a specified job. |
+| `status` | | Returns all modules and a sample of information including, state, jobs queued, running and paused, concurrency (amount of jobs that can run simultaneously), and (startup) stage. |
+| `queued` | `module` | Returns all jobs queued for specified module. |
+| `running` | `module` | Returns all jobs running for specified module. |
+| `paused` | `module` | Returns all jobs paused for specified module. |
+| `jobinfo` | `UUID` | Returns a detailed overview of a specified job. |
+| `runjob` | `module job_name json_encoded_payload` | Run a specified job in a specified module including a JSON encoded payload, and return response. |
+| `eval` | `some_javascript` | Execute JavaScript within the index.js context and return response. |
+| `lockdown` | | Lockdown backend. |
+| `stats` | `module` | Returns job statistics for a specified module. |
 
 ## Modules
 When specifying a module please use all lowercase. The available modules are as follows:

+ 4 - 2
.wiki/Installation.md

@@ -16,10 +16,12 @@ Musare can be installed with Docker (recommended) or without, guides for both in
 5. `cp .env.example .env` and configure as per [Configuration](./Configuration.md#Docker-Environment).
 6. `./musare.sh build`
 7. `./musare.sh start`
-8. Register a new user on the website and grant the admin role by running `./musare.sh admin add USERNAME`.
+8. **(optional)** Register a new user on the website and grant the admin role by running `./musare.sh admin add USERNAME`.
 
 ### Fixing the "couldn't connect to docker daemon" error
 
+**Windows Only**
+
 Some people have had issues while trying to execute the `docker-compose` command.
 To fix this, you will have to run `docker-machine env default`.
 This command will print various variables.
@@ -56,7 +58,7 @@ Run this command in your shell. You will have to do this command for every shell
         - **Manual**
             1. Run `startRedis.cmd` and `startMongo.cmd` to start Redis and Mongo.
             2. Execute `cd frontend && npm run dev` and `cd backend && npm run dev` separately.
-8. Register a new user on the website and grant the admin role by running the following in the mongodb shell.
+8. **(optional)** Register a new user on the website and grant the admin role by running the following in the mongodb shell.
     ```bash
     use musare
     db.auth("MUSAREDBUSER","MUSAREDBPASSWORD")

+ 0 - 4
README.md

@@ -4,10 +4,6 @@
 
 Musare is an open-source collaborative music listening and catalogue curation application. Currently supporting YouTube based content.
 
-The master branch is available at [musare.com](https://musare.com).
-
-You can also find the staging branch at [musare.dev](https://musare.dev).
-
 ---
 
 ## Documentation