Skip to content

Home

Jump to bottom
Dmitry Sorokin (@sorydima) edited this page Nov 19, 2024 · 1 revision

Wiki Structure for NS1

1. Home

  • Brief description of NS1 GrapheneOS.
    • Main functions and goals.
    • Links to GrapheneOS resources.

2. Getting Started

  • Installation and configuration of the project.
  • Requirements for developers.

3. Infrastructure Overview

  • Description of the NS1 infrastructure.
  • Architecture of DNS and network components.

4. Deployment

  • Deployment recommendations.
  • Local and cloud scenarios.

5. Security and Privacy

  • Security methods.
  • Privacy of user data.

6. Contribution

  • How to contribute to the project.
    • Recommendations for writing code.

7. FAQ

  • Answers to popular questions.

8. License

  • Licensing terms.

9. Acknowledgements

  • Thanks to the team and the community.

Home.md

# Welcome to the NS1 GrapheneOS Wiki

NS1 is a highly secure DNS infrastructure to support GrapheneOS. It provides anonymous, fast, and private DNS services specifically designed to enhance network security and stability.

## Main goals
- Elimination of vulnerabilities in traditional DNS systems.
- Protecting users from surveillance and attacks.
- Ensuring reliable network operation.

## Related Resources
- [GrapheneOS Official Website](https://grapheneos.org )
- [GrapheneOS Documentation](https://grapheneos.org/docs )
- [GrapheneOS Repositories](https://github.com/Katya-Incorporated )

Join the project to make the Internet safer!

Getting_Started.md

# Getting Started

## Requirements
- **System requirements**: Linux (Ubuntu 20.04+), macOS.
- **Dependencies**:
- Docker (version 20.10+).
  - Python (version 3.9+).

## Installation
1. Clone the repository:
   ```bash
   git clone https://github.com/Katya-Incorporated/ns1.grapheneos.org.git
   cd ns1.grapheneos.org
  1. Install the dependencies: ``bash pip install -r requirements.txt
  2. Start the local server: 
    docker-compose up --build

After completing these steps, you are ready to use NS1!


---

### **Infrastructure_Overview.md**
```markdown
# Infrastructure Overview

## Architecture
NS1 works as a decentralized DNS system with enhanced security. The main components:
1. **DNS Relays**:
- Provide routing of requests.
   - Encrypt data during transmission.

2. **Monitoring modules**:
- Monitor the performance of the system.
   - Prevent DDoS attacks.

## Example of a structure
```plaintext
[Client] --> [DNS Relay] --> [NS1 Center] --> [Target Server]

This structure minimizes vulnerabilities and increases network resilience.


---

### **Deployment.md**
```markdown
# Deployment Guide

## Local deployment
1. Make sure Docker is installed:
``bash
   docker --version

  1. Launch Docker Compose:

    docker-compose up

  2. Check availability:

Cloud deployment

  1. Set up a cloud server (AWS/GCP).

  2. Copy the configuration files:

    scp config/* user@server:/etc/ns1/

  3. Run the deployment script:

    bash scripts/deploy_cloud.sh

For more information, see the deployment/ folder.


---

### **Security_and_Privacy.md**
```markdown
# Security and Privacy

## Security methods
- **DNS over HTTPS (DoH)**: All requests are encrypted.
- **Authentication**: SSH keys and TLS certificates are used.

## Privacy Tips
- Configure DNS clients to work with DoH.
- Disable logging on the relays.

For more information, examine the file `SECURITY.md `.

Contribution.md

# Contribution Guidelines

## How to get started
1. Fork the repository and create a branch:
``bash
   git checkout -b feature/your-feature
  1. Make changes and send a pull request.
  2. Make sure that your code complies with [PEP 8](https://peps.python.org/pep-0008 /).

Repository structure

  • src/: Source code.
  • config/: Configuration files.
  • docs/: Documentation.

Let's develop the project together! ``

FAQ.md

# FAQ

## Frequently Asked Questions

### Q: How do I use NS1 with my device?
A: Configure the DNS client to work with the NS1 address.

### Q: How do I fix malfunctions?
A: Check the network configuration and error logs.

### Q: Is it possible to deploy NS1 on Windows?
A: Yes, but it is recommended to use WSL for full compatibility.

License.md

# License

This project is distributed under the MIT license. The full text is available in the [LICENSE] file (https://github.com/Katya-Incorporated/ns1 .grapheneos.org/blob/main/LICENSE).

Acknowledgements.md

# Acknowledgements

This project was created thanks to:
- To the GrapheneOS team for their contribution to the development of secure technologies.
- Open-source community for tools and support.
- To all participants who help develop NS1.

Thank you for making the Internet better!
``
Clone this wiki locally