update docs.
This commit is contained in:
parent
e25e9c2b24
commit
ac822a2531
@ -8,11 +8,13 @@
|
|||||||
- Added `NEKO_PATH_PREFIX`.
|
- Added `NEKO_PATH_PREFIX`.
|
||||||
- Added screenshot function `/screenshot.jpg?pwd=<admin>`, works only for unlocked rooms.
|
- Added screenshot function `/screenshot.jpg?pwd=<admin>`, works only for unlocked rooms.
|
||||||
- Added emoji support (by @yesBad).
|
- Added emoji support (by @yesBad).
|
||||||
|
- Added file transfer (by @prophetofxenu).
|
||||||
|
|
||||||
### Misc
|
### Misc
|
||||||
- Server: Split `remote` to `desktop` and `capture`.
|
- Server: Split `remote` to `desktop` and `capture`.
|
||||||
- Server: Refactored `xorg` - added `xevent` and clipboard is handled as event (no looped polling anymore).
|
- Server: Refactored `xorg` - added `xevent` and clipboard is handled as event (no looped polling anymore).
|
||||||
- Introduced `NEKO_AUDIO_CODEC=` and `NEKO_VIDEO_CODEC=` as a new way of setting codecs.
|
- Introduced `NEKO_AUDIO_CODEC=` and `NEKO_VIDEO_CODEC=` as a new way of setting codecs.
|
||||||
|
- Added CORS.
|
||||||
|
|
||||||
## [n.eko v2.6](https://github.com/m1k1o/neko/releases/tag/v2.6)
|
## [n.eko v2.6](https://github.com/m1k1o/neko/releases/tag/v2.6)
|
||||||
|
|
||||||
|
@ -32,6 +32,7 @@ nat1to1: <ip>
|
|||||||
- Currently supported:
|
- Currently supported:
|
||||||
- `control`
|
- `control`
|
||||||
- `login`
|
- `login`
|
||||||
|
- `file_transfer`
|
||||||
- e.g. `control`
|
- e.g. `control`
|
||||||
|
|
||||||
### WebRTC
|
### WebRTC
|
||||||
@ -125,18 +126,18 @@ nat1to1: <ip>
|
|||||||
#### `NEKO_PATH_PREFIX`:
|
#### `NEKO_PATH_PREFIX`:
|
||||||
- Path prefix for HTTP requests.
|
- Path prefix for HTTP requests.
|
||||||
- e.g. `/neko/`
|
- e.g. `/neko/`
|
||||||
|
#### `NEKO_CORS`:
|
||||||
|
- Cross origin request sharing, whitespace separated list of allowed hosts, `*` for all.
|
||||||
|
- e.g. `127.0.0.1 neko.example.com`
|
||||||
|
|
||||||
### File Transfer
|
### File Transfer
|
||||||
|
|
||||||
#### `NEKO_FILE_TRANSFER`:
|
#### `NEKO_FILE_TRANSFER_ENABLED`:
|
||||||
- Enable file transfer for admins at start
|
- Enable file transfer feature.
|
||||||
- e.g. `1`
|
- e.g. `true`
|
||||||
#### `NEKO_UNPRIV_FILE_TRANSFER`:
|
|
||||||
- Enable file transfer for all users at start. Ignored if NEKO_FILE_TRANSFER not enabled.
|
|
||||||
- e.g. `1`
|
|
||||||
#### `NEKO_FILE_TRANSFER_PATH`:
|
#### `NEKO_FILE_TRANSFER_PATH`:
|
||||||
- Path where files will be transferred between the host and users. By default this is
|
- Path where files will be transferred between the host and users. By default this is
|
||||||
/home/neko/Downloads. If the path doesn't exist, it will be created.
|
`/home/neko/Downloads`. If the path doesn't exist, it will be created.
|
||||||
- e.g. `/home/neko/Desktop`
|
- e.g. `/home/neko/Desktop`
|
||||||
|
|
||||||
### Expert settings
|
### Expert settings
|
||||||
@ -165,10 +166,11 @@ Flags:
|
|||||||
--broadcast_url string URL for broadcasting, setting this value will automatically enable broadcasting
|
--broadcast_url string URL for broadcasting, setting this value will automatically enable broadcasting
|
||||||
--cert string path to the SSL cert used to secure the neko server
|
--cert string path to the SSL cert used to secure the neko server
|
||||||
--control_protection control protection means, users can gain control only if at least one admin is in the room
|
--control_protection control protection means, users can gain control only if at least one admin is in the room
|
||||||
|
--cors strings list of allowed origins for CORS (default [*])
|
||||||
--device string audio device to capture (default "auto_null.monitor")
|
--device string audio device to capture (default "auto_null.monitor")
|
||||||
--display string XDisplay to capture (default ":99.0")
|
--display string XDisplay to capture (default ":99.0")
|
||||||
--epr string limits the pool of ephemeral ports that ICE UDP connections can allocate from (default "59000-59100")
|
--epr string limits the pool of ephemeral ports that ICE UDP connections can allocate from (default "59000-59100")
|
||||||
--file_transfer allow file transfer for admins
|
--file_transfer_enabled enable file transfer feature (default false)
|
||||||
--file_transfer_path string path to use for file transfer (default "/home/neko/Downloads")
|
--file_transfer_path string path to use for file transfer (default "/home/neko/Downloads")
|
||||||
--g722 DEPRECATED: use audio_codec
|
--g722 DEPRECATED: use audio_codec
|
||||||
--h264 DEPRECATED: use video_codec
|
--h264 DEPRECATED: use video_codec
|
||||||
@ -194,7 +196,6 @@ Flags:
|
|||||||
--static string path to neko client files to serve (default "./www")
|
--static string path to neko client files to serve (default "./www")
|
||||||
--tcpmux int single TCP mux port for all peers
|
--tcpmux int single TCP mux port for all peers
|
||||||
--udpmux int single UDP mux port for all peers
|
--udpmux int single UDP mux port for all peers
|
||||||
--unpriv_file_transfer allow file transfer for non admins
|
|
||||||
--video string video codec parameters to use for streaming
|
--video string video codec parameters to use for streaming
|
||||||
--video_bitrate int video bitrate in kbit/s (default 3072)
|
--video_bitrate int video bitrate in kbit/s (default 3072)
|
||||||
--video_codec string video codec to be used (default "vp8")
|
--video_codec string video codec to be used (default "vp8")
|
||||||
|
@ -1,12 +1,13 @@
|
|||||||
package config
|
package config
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"m1k1o/neko/internal/utils"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"path"
|
"path"
|
||||||
|
|
||||||
"github.com/spf13/cobra"
|
"github.com/spf13/cobra"
|
||||||
"github.com/spf13/viper"
|
"github.com/spf13/viper"
|
||||||
|
|
||||||
|
"m1k1o/neko/internal/utils"
|
||||||
)
|
)
|
||||||
|
|
||||||
type Server struct {
|
type Server struct {
|
||||||
|
@ -47,7 +47,7 @@ func (WebSocket) Init(cmd *cobra.Command) error {
|
|||||||
|
|
||||||
// File transfer
|
// File transfer
|
||||||
|
|
||||||
cmd.PersistentFlags().Bool("file_transfer_enabled", true, "enable file transfer feature")
|
cmd.PersistentFlags().Bool("file_transfer_enabled", false, "enable file transfer feature")
|
||||||
if err := viper.BindPFlag("file_transfer_enabled", cmd.PersistentFlags().Lookup("file_transfer_enabled")); err != nil {
|
if err := viper.BindPFlag("file_transfer_enabled", cmd.PersistentFlags().Lookup("file_transfer_enabled")); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user