Custom Layout!
-+
+### 获取Github的Client ID和密钥 +---- +哪吒监控接入Github和Gitee作为后台管理员账号 ++ 首先我们需要新建一个验证应用，以Github为例，登陆Github后，打开 https://github.com/settings/developers ，依次选择“OAuth Apps” - “New OAuth App” +`Application name` - 随意填写 +`Homepage URL` - 填写面板的访问域名，如："http://cdn.example.com" +`Authorization callback URL` - 填写回调地址，如："http://cdn.example.com/oauth2/callback" ++ 点击“Register application” ++ 保存页面中的Client ID，然后点击 “Generate a new client secret“，创建一个新的Client Secret，新建的密钥仅会显示一次，请妥善保存 +
+
+### 在服务器中安装Dashboard +--- +* 在面板服务器中，运行安装脚本： +```bash +curl -L https://raw.githubusercontent.com/naiba/nezha/master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo ./nezha.sh +``` +如果你的面板服务器位于中国大陆，可以使用镜像： +````bash +curl -L https://fastly.jsdelivr.net/gh/naiba/nezha@master/script/install.sh -o nezha.sh && chmod +x nezha.sh && sudo CN=true ./nezha.sh +```` + +* 等待Docker安装完毕后，分别输入以下值： +`OAuth提供商` - Github或Gitee +`Client ID` - 之前保存的Client ID +`Client Secret` - 之前保存的密钥 +`用户名` - Github或Gitee的用户名 +`站点标题` - 自定义站点标题 +`访问端口` - 公开访问端口，可自定义，默认8008 +`Agent的通信端口` - Agent与Dashboard的通信端口，默认5555 + +* 输入完成后，等待拉取镜像 +安装结束后，如果一切正常，此时你可以访问域名+端口号，如 “http://cdn.example.com:8008” 来查看面板 + +* 将来如果需要再次运行脚本，可以运行： +```bash +./nezha.sh +``` +来打开管理脚本 +
+
+### 配置反向代理 +--- +* 在宝塔面板中新建一个站点，域名填写公开访问域名，如 “http://cdn.example.com“ ，然后点击“设置”进入站点设置选项，选择“反向代理” - “新建反向代理” + +* 自定义一个代理名称，在下方“目标URL”中填入 `http://127.0.0.1` 然后点击“保存” + +* 打开刚刚新建的反向代理右边的“配置文件”，将配置文件替换为以下内容： +````nginx +#PROXY-START/ +location / { + proxy_pass http://127.0.0.1:8008; + proxy_set_header Host $host; + proxy_set_header Upgrade $http_upgrade; +} +location ~ ^/(ws|terminal/.+)$ { + proxy_pass http://127.0.0.1:8008; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "Upgrade"; + proxy_set_header Host $host; +} +#PROXY-END/ +```` +* 点击“保存” +现在，你应该可以直接使用域名，如：“http://cdn.example.com“ 来访问面板了 +
+#### 扩展内容： + + +* CaddyServer v1（v2 无需特别配置） + + ```Caddyfile + proxy /ws http://ip:8008 { + websocket + } + proxy /terminal/* http://ip:8008 { + websocket + } + ``` + +
+
+ +### 在宝塔面板中配置SSL +--- +首先，先暂时关闭反向代理 +正如在其他网站中配置SSL证书一样，进入站点设置中的“SSL”，你可以选择自动申请 Let´s Encrypt 证书或手动配置已有的证书 +完成SSL的设置后，你需要回到 https://github.com/settings/developers ，编辑之前创建的验证应用程序，将之前我们填入的"Homepage URL"和"Authorization callback URL"中的域名全部从`http`改为`https`，如："https://cdn.example.com" 和 "https://cdn.example.com/oauth2/callback" ，**不更改此项可能会导致你无法登陆面板后台** \ No newline at end of file diff --git a/docs/guide/deploy.md b/docs/guide/deploy.md deleted file mode 100644 index 8497ecd6..00000000 --- a/docs/guide/deploy.md +++ /dev/null @@ -1,267 +0,0 @@ ---- -sidebarDepth: 3 ---- - -# Deploying - -The following guides are based on some shared assumptions: - -- You are placing your docs inside the `docs` directory of your project; -- You are using the default build output location (`.vitepress/dist`); -- VitePress is installed as a local dependency in your project, and you have setup the following npm scripts: - -```json -{ - "scripts": { - "docs:build": "vitepress build docs", - "docs:serve": "vitepress serve docs" - } -} -``` - -## Building The Docs - -You may run `yarn docs:build` command to build the docs. - -```bash -$ yarn docs:build -``` - -By default, the build output will be placed at `.vitepress/dist`. You may deploy this `dist` folder to any of your preferred platforms. - -### Testing The Docs Locally - -Once you've built the docs, you may test them locally by running `yarn docs:serve` command. - -```bash -$ yarn docs:build -$ yarn docs:serve -``` - -The `serve` command will boot up local static web server that serves the files from `.vitepress/dist` at `http://localhost:5000`. It's an easy way to check if the production build looks OK in your local environment. - -You may configure the port of the server py passing `--port` flag as an argument. - -```json -{ - "scripts": { - "docs:serve": "vitepress serve docs --port 8080" - } -} -``` - -Now the `docs:serve` method will launch the server at `http://localhost:8080`. - -## GitHub Pages - -1. Set the correct `base` in `docs/.vitepress/config.js`. - - If you are deploying to `https://
$frontmatter variable.
-
-Here’s an example of how you could use it in your Markdown file:
-
-```md
----
-title: Docs with VitePress
-editLink: true
----
-
-# {{ $frontmatter.title }}
-
-Guide content
-```
-
-## Alternative frontmatter Formats
-
-VitePress also supports JSON frontmatter syntax, starting and ending in curly braces:
-
-```json
----
-{
- "title": "Blogging Like a Hacker",
- "editLink": true
-}
----
-```
-
-## Predefined Variables
-
-### title
-
-- Type: `string`
-- Default: `h1_title || siteData.title`
-
-Title of the current page.
-
-### head
-
-- Type: `array`
-- Default: `undefined`
-
-Specify extra head tags to be injected:
-
-```yaml
----
-head:
- - - meta
- - name: description
- content: hello
- - - meta
- - name: keywords
- content: super duper SEO
----
-```
-
-### navbar
-
-- Type: `boolean`
-- Default: `undefined`
-
-You can disable the navbar on a specific page with `navbar: false`
-
-### sidebar
-
-- Type: `boolean|'auto'`
-- Default: `undefined`
-
-You can decide to show the sidebar on a specific page with `sidebar: auto` or disable it with `sidebar: false`
-
-### editLink
-
-- Type: `boolean`
-- Default: `undefined`
-
-Define if this page should include an edit link.
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
deleted file mode 100644
index 2b891fd3..00000000
--- a/docs/guide/getting-started.md
+++ /dev/null
@@ -1,51 +0,0 @@
-# Getting Started
-
-This section will help you build a basic VitePress documentation site from ground up. If you already have an existing project and would like to keep documentation inside the project, start from Step 3.
-
-- **Step. 1:** Create and change into a new directory.
-
- ```bash
- $ mkdir vitepress-starter && cd vitepress-starter
- ```
-
-- **Step. 2:** Initialize with your preferred package manager.
-
- ```bash
- $ yarn init
- ```
-
-- **Step. 3:** Install VitePress locally.
-
- ```bash
- $ yarn add --dev vitepress
- ```
-
-- **Step. 4:** Create your first document.
-
- ```bash
- $ mkdir docs && echo '# Hello VitePress' > docs/index.md
- ```
-
-- **Step. 5:** Add some scripts to `package.json`.
-
- ```json
- {
- "scripts": {
- "docs:dev": "vitepress dev docs",
- "docs:build": "vitepress build docs",
- "docs:serve": "vitepress serve docs"
- }
- }
- ```
-
-- **Step. 6:** Serve the documentation site in the local server.
-
- ```bash
- $ yarn docs:dev
- ```
-
- VitePress will start a hot-reloading development server at `http://localhost:3000`.
-
-By now, you should have a basic but functional VitePress documentation site.
-
-When your documentation site starts to take shape, be sure to read the [deployment guide](./deploy).
diff --git a/docs/guide/global-component.md b/docs/guide/global-component.md
deleted file mode 100644
index ce843322..00000000
--- a/docs/guide/global-component.md
+++ /dev/null
@@ -1,32 +0,0 @@
-# Global Component
-
-VitePress comes with few built-in component that can be used globally. You may use these components in your markdown or your custom theme configuration.
-
-## Content
-
-The `Content` component displays the rendered markdown contents. Useful [when creating your own theme](./theming).
-
-```vue
-
- Custom Layout!
--
-
- - {{ todo.text }} - -
-
-
- {{ todo.text }} -
-
-Custom Layout!
-{{ page }}
-```
-
-**Output**
-
-```json
-{
- "path": "/using-vue.html",
- "title": "Using Vue in Markdown",
- "frontmatter": {}
-}
-```
-
-## Escaping
-
-By default, fenced code blocks are automatically wrapped with `v-pre`. To display raw mustaches or Vue-specific syntax inside inline code snippets or plain text, you need to wrap a paragraph with the `v-pre` custom container:
-
-**Input**
-
-```md
-::: v-pre
-`{{ This will be displayed as-is }}`
-:::
-```
-
-**Output**
-
-::: v-pre
-`{{ This will be displayed as-is }}`
-:::
-
-## Using Components
-
-When you need to have more flexibility, VitePress allows you to extend your authoring toolbox with your own Vue Components.
-
-### Importing components in markdown
-
-If your components are going to be used in only a few places, the recommended way to use them is to importing the components in the file where it is used.
-
-```md
-
-
-# Docs
-
-This is a .md using a custom component
-
-` tag, which will lead to hydration mismatch because `
` does not allow block elements to be placed inside it.
-:::
-
-### Using Components In Headers
# text <Tag/> text
` | `text` |
-| # text \`<Tag/>\` text <Tag/>
` | `text ` will be displayed as-is; only the HTML that is **not** wrapped will be parsed by Vue.
-
-::: tip
-The output HTML is accomplished by [markdown-it](https://github.com/markdown-it/markdown-it), while the parsed headers are handled by VitePress (and used for both the sidebar and document title).
-:::
-
-## Using CSS Pre-processors
-
-VitePress has [built-in support](https://vitejs.dev/guide/features.html#css-pre-processors) for CSS pre-processors: `.scss`, `.sass`, `.less`, `.styl` and `.stylus` files. There is no need to install Vite-specific plugins for them, but the corresponding pre-processor itself must be installed:
-
-```
-# .scss and .sass
-npm install -D sass
-
-# .less
-npm install -D less
-
-# .styl and .stylus
-npm install -D stylus
-```
-
-Then you can use the following in Markdown and theme components:
-
-```vue
-
-```
-
-## Script & Style Hoisting
-
-Sometimes you may need to apply some JavaScript or CSS only to the current page. In those cases, you can directly write root-level `
-
-## Built-In Components
-
-VitePress provides Built-In Vue Components like `ClientOnly` and `OutboundLink`, check out the [Global Component Guide](./global-component) for more information.
-
-**Also see:**
-
-- [Using Components In Headers](#using-components-in-headers)
-
-## Browser API Access Restrictions
-
-Because VitePress applications are server-rendered in Node.js when generating static builds, any Vue usage must conform to the [universal code requirements](https://vuejs.org/guide/scaling-up/ssr.html). In short, make sure to only access Browser / DOM APIs in `beforeMount` or `mounted` hooks.
-
-If you are using or demoing components that are not SSR-friendly (for example, contain custom directives), you can wrap them inside the built-in `` component:
-
-```md
-
-
-```
-
-Note this does not fix components or libraries that access Browser APIs **on import**. To use code that assumes a browser environment on import, you need to dynamically import them in proper lifecycle hooks:
-
-```vue
-
-```
-
-If your module `export default` a Vue component, you can register it dynamically:
-
-```vue
-
-