Skip to content

Commit f9562f2

Browse files
committed
chore: renamed product name
1 parent e8ae9a9 commit f9562f2

31 files changed

+64
-1890
lines changed

.github/workflows/deploy.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jobs:
3939
env:
4040
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
4141
with:
42-
channel_id: 'C01C9NKCXMF' # '#01_unid'
42+
channel_id: 'C01C9NKCXMF' # '#01_nodex'
4343
status: SUCCESS
4444
color: good
4545

@@ -48,6 +48,6 @@ jobs:
4848
env:
4949
SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
5050
with:
51-
channel_id: 'C01C9NKCXMF' # '#01_unid'
51+
channel_id: 'C01C9NKCXMF' # '#01_nodex'
5252
status: FAILED
5353
color: danger

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ This document follows the [Sphinx](https://www.sphinx-doc.org) documentation fra
88

99
**Clone the repository**
1010
```bash
11-
git clone https://github.com/getunid/unid-docs.git
12-
cd unid-docs
11+
git clone https://github.com/getnodex/nodex-docs.git
12+
cd nodex-docs
1313
git switch -c sphinx origin/sphinx
1414
```
1515

@@ -25,7 +25,7 @@ make watch
2525

2626
## Contributing
2727

28-
[Click here](https://github.com/getunid/unid-docs/issues/new/choose) for `bug report` and `feature request` regarding the contents of this document. Thanks for your feedback to help us to improve.
28+
[Click here](https://github.com/getnodex/nodex-docs/issues/new/choose) for `bug report` and `feature request` regarding the contents of this document. Thanks for your feedback to help us to improve.
2929

3030
## License
3131

source/_assets/nodex_logo.svg

+3
Loading

source/_assets/nodex_logo_full.svg

+4
Loading

source/_static/css/style.css

+1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ code.docutils * {
4545
font-family: ui-monospace,SFMono-Regular,SF Mono,Menlo,Consolas,Liberation Mono,monospace;
4646
font-weight: bold;
4747
}
48+
.highlight *,
4849
.highlight-js *,
4950
.highlight-json * {
5051
font-size: 12px;

source/api_reference/index.md

-179
This file was deleted.

source/build_guide/linux/index.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,13 @@ Execute the above command and make sure that the version of Rust is 1.65.0 or la
9898
- **NodeX EDGE: Getting the GitHub repository (clone)**
9999

100100
```
101-
[user@linux]$ git clone https://github.com/getunid/unid.git
101+
[user@linux]$ git clone https://github.com/getnodex/nodex.git
102102
```
103103

104104
- **Go to NodeX EDGE directory**
105105

106106
```
107-
[user@linux]$ cd unid/
107+
[user@linux]$ cd nodex/
108108
```
109109

110110
- **Commit head start (checkout)**
@@ -134,7 +134,7 @@ warning: `panic` setting is ignored for `test` profile
134134
135135
(SNIP)
136136
137-
warning: `unid` (bin "unid-agent") generated 78 warnings
137+
warning: `nodex` (bin "nodex-agent") generated 78 warnings
138138
Finished release [optimized] target(s) in 4m 31s
139139
```
140140

@@ -149,34 +149,34 @@ drwxrwxr-x 134 parallels parallels 12288 Nov 4 16:25 build/
149149
drwxrwxr-x 2 parallels parallels 126976 Nov 4 16:33 deps/
150150
drwxrwxr-x 2 parallels parallels 4096 Nov 4 15:57 examples/
151151
drwxrwxr-x 2 parallels parallels 4096 Nov 4 15:57 incremental/
152-
-rwxrwxr-x 2 parallels parallels 12499616 Nov 4 16:33 unid-agent*
153-
-rw-rw-r-- 1 parallels parallels 2688 Nov 4 16:33 unid-agent.d
152+
-rwxrwxr-x 2 parallels parallels 12499616 Nov 4 16:33 nodex-agent*
153+
-rw-rw-r-- 1 parallels parallels 2688 Nov 4 16:33 nodex-agent.d
154154
```
155155

156156
These steps will complete the build of NodeX EDGE. Verify that the build artifacts exist in the following path
157157

158-
- **target/x86_64-unknown-linux-musl/release/unid-agent**
158+
- **target/x86_64-unknown-linux-musl/release/nodex-agent**
159159

160-
The build artifact (unid-agent) can be executed by properly deploying it on the execution environment specified at build time; the API reference provided by NodeX EDGE is described in subsequent chapters.
160+
The build artifact (nodex-agent) can be executed by properly deploying it on the execution environment specified at build time; the API reference provided by NodeX EDGE is described in subsequent chapters.
161161

162162
## First time starting up
163163

164164
The NodeX EDGE built in the previous steps should be moved to any directory on the LinuxOS (generally /usr/local/bin is a good place to put it).
165165

166166
```
167-
[user@linux]$ sudo mv target/x86_64-unknown-linux-musl/release/unid-agent /usr/local/bin
167+
[user@linux]$ sudo mv target/x86_64-unknown-linux-musl/release/nodex-agent /usr/local/bin
168168
```
169169

170170
NodeX EDGE has a daemon startup function in the binary itself and can be started in a daemon state by specifying options. The following snippet shows how to start NodeX EDGE in a non-daemon state.
171171

172172
```
173-
[user@linux]$ unid-agent
173+
[user@linux]$ nodex-agent
174174
```
175175

176176
The following snippet shows how to start NodeX EDGE in daemon state.
177177

178178
```
179-
[user@linux]$ unid-agent --daemonize
179+
[user@linux]$ nodex-agent --daemonize
180180
```
181181

182182
There is no difference in the functionality provided by NodeX EDGE in either method, and other applications capable of IPC (Unix Domain Socket) communication can still make requests to the NodeX EDGE Agent.
@@ -187,8 +187,8 @@ To verify that it was installed correctly, run the following snippet. If the res
187187

188188
```
189189
curl -X GET H 'content-type: application/json' \
190-
--unix-socket /usr/local/bin/unid-agent.sock \
191-
'http:/local/identifiers/did:unid:test:ey………'
190+
--unix-socket /usr/local/bin/nodex-agent.sock \
191+
'http:/local/identifiers/did:nodex:test:ey………'
192192
```
193193

194194
Please refer to the API Reference page for more information on how to use NodeX EDGE.

source/index.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Welcome to NodeX Documentation!
22

3-
```{image} _assets/unid_u_logo.svg
3+
```{image} _assets/nodex_logo.svg
44
:align: center
5+
:width: 100
56
```
67

78
<h1 style="text-align: center;">
89
NodeX
910

10-
[![Release Pipeline](https://github.com/getunid/unid/actions/workflows/release-pipeline.yml/badge.svg?branch=main)](https://github.com/getunid/unid/actions/workflows/release-pipeline.yml) [![Coverage Status](https://coveralls.io/repos/github/getunid/unid/badge.svg)](https://coveralls.io/github/getunid/unid) [![Crates](https://img.shields.io/crates/v/unid.svg)](https://crates.io/crates/unid) [![Semantic Release](https://img.shields.io/badge/semantic--release-rust-B7410E?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
11+
[![Release Pipeline](https://github.com/nodecross/nodex-agent/actions/workflows/release-pipeline.yml/badge.svg?branch=main)](https://github.com/nodecross/nodex-agent/actions/workflows/release-pipeline.yml) [![Coverage Status](https://coveralls.io/repos/github/nodecross/nodex-agent/badge.svg)](https://coveralls.io/github/nodecross/nodex-agent) [![Semantic Release](https://img.shields.io/badge/semantic--release-rust-B7410E?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
1112
</h1>
1213

1314
<hr />
@@ -17,12 +18,10 @@ NodeX is an open-source toolkit for building end-to-end secure messaging between
1718
```{toctree}
1819
:hidden:
1920
introduction/index.md
20-
unid/index.md
21-
unid_edge/index.md
21+
nodex/index.md
22+
nodex_edge/index.md
2223
build_guide/linux/index.md
23-
api_reference/index.md
2424
rpc_reference/index.md
2525
interface_definitions/index.md
2626
glossary/index.md
27-
preview/index.md
2827
```

source/interface_definitions/index.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,39 @@ This chapter defines the API interface required for development when replacing o
55
## True random number generation
66

77
```
8-
Method: unid_err_t unid_read_trng(void *result_ptr)
8+
Method: nodex_err_t nodex_read_trng(void *result_ptr)
99
```
1010

11-
This is implemented when replacing the process of generating true random numbers. Accesses its own TRNG module inside the shared library, and links true random numbers to NodeX EDGE through a pointer. The return value of the method follows the definition of unid_err_t.
11+
This is implemented when replacing the process of generating true random numbers. Accesses its own TRNG module inside the shared library, and links true random numbers to NodeX EDGE through a pointer. The return value of the method follows the definition of nodex_err_t.
1212

1313
## Save private keys
1414

1515
```
16-
Method: unid_err_t unid_write_private_key(char *private_key)
16+
Method: nodex_err_t nodex_write_private_key(char *private_key)
1717
```
1818

19-
Implement this when replacing the private key storage process. The private key is stored inside the shared library using a proprietary cipher, etc. The return value of the method follows the definition of unid_err_t. The return value of the method follows the definition of unid_err_t.
19+
Implement this when replacing the private key storage process. The private key is stored inside the shared library using a proprietary cipher, etc. The return value of the method follows the definition of nodex_err_t. The return value of the method follows the definition of nodex_err_t.
2020

2121
## Find private keys
2222

2323
```
24-
Method: unid_err_t unid_read_private_key(void *result_ptr)
24+
Method: nodex_err_t nodex_read_private_key(void *result_ptr)
2525
```
2626

27-
This function is implemented when the process of reading out the private key is replaced. The private key is read out using a unique cipher or other device inside the shared library, and the private key is linked to the NodeX EDGE through a pointer. The return value of the method follows the definition of unid_err_t.
27+
This function is implemented when the process of reading out the private key is replaced. The private key is read out using a unique cipher or other device inside the shared library, and the private key is linked to the NodeX EDGE through a pointer. The return value of the method follows the definition of nodex_err_t.
2828

2929
## Encryption Data
3030

3131
```
32-
Method: unid_err_t unid_encrypt_message(char *message, void *result_ptr)
32+
Method: nodex_err_t nodex_encrypt_message(char *message, void *result_ptr)
3333
```
3434

3535
(TBD)
3636

3737
## Decryption Data
3838

3939
```
40-
Method: unid_err_t unid_decrypt_message(char *message, void *result_ptr)
40+
Method: nodex_err_t nodex_decrypt_message(char *message, void *result_ptr)
4141
```
4242

4343
(TBD)

0 commit comments

Comments
 (0)