diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..e59bf93 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,40 @@ +name: 🐛 Bug +description: Report an issue to help improve the project. +title: "🐛 " +labels: ["🛠ī¸ goal: fix","đŸšĻ status: awaiting triage"] +body: + - type: textarea + id: description + attributes: + label: Description + description: A brief description of the question or issue, also include what you tried and what didn't work + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: false + options: + - "Yes" + - "No" + validations: + required: false + - type: textarea + id: extrainfo + attributes: + label: Additional information + description: Is there anything else we should know about this bug? + validations: + required: false + - type: markdown + attributes: + value: | + You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 74f5722..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG] " -labels: bug -assignees: '' - ---- - - - -**Version of Websurfx, commit number if you are using on master branch** - - -**How did you install Websurfx?** - - -**What happened?** - - -**Steps To Reproduce** - - -**Expected behavior** - - -**Screenshots** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 0086358..97ba6bf 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,5 @@ -blank_issues_enabled: true +blank_issues_enabled: false +contact_links: + - name: Question? + url: https://discord.gg/SWnda7Mw5u + about: Feel free to ask your question by joining our Discord server. diff --git a/.github/ISSUE_TEMPLATE/docs.yml b/.github/ISSUE_TEMPLATE/docs.yml new file mode 100644 index 0000000..d8f1c83 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/docs.yml @@ -0,0 +1,40 @@ +name: 📝 Documentation issue +description: Found an issue in the documentation? You can use this one! +title: "📝 " +labels: ["📄 aspect: text","đŸšĻ status: awaiting triage"] +body: + - type: textarea + id: description + attributes: + label: Description + description: A brief description of the question or issue, also include what you tried and what didn't work + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: false + options: + - "Yes" + - "No" + validations: + required: false + - type: textarea + id: extrainfo + attributes: + label: Additional information + description: Is there anything else we should know about this issue? + validations: + required: false + - type: markdown + attributes: + value: | + You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u) diff --git a/.github/ISSUE_TEMPLATE/engine-request.md b/.github/ISSUE_TEMPLATE/engine-request.md deleted file mode 100644 index faacb92..0000000 --- a/.github/ISSUE_TEMPLATE/engine-request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Engine request -about: 'Suggest a new engine to be add ' -title: "[ENGINE] " -labels: engine -assignees: '' - ---- - - - -**Working URL of the engine** - - -**Why do you want to add this engine?** - - -**Features of this engine** - - -**Applicable category of this engine** - - -**Additional context** - diff --git a/.github/ISSUE_TEMPLATE/engine.yml b/.github/ISSUE_TEMPLATE/engine.yml new file mode 100644 index 0000000..ee55d5e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/engine.yml @@ -0,0 +1,72 @@ +name: ✨ Engine +description: Have a new engine to suggest for Websurfx? Please suggest! +title: '✨ ' +labels: ['⭐ goal: addition', 'đŸšĻ status: awaiting triage'] +body: + - type: textarea + id: workingUrl + attributes: + label: Working URL of the engine + description: Please check if the engine is responding correctly before submitting it. + validations: + required: true + - type: textarea + id: reason + attributes: + label: Why do you want to add this engine? + description: What's special about this engine? Is it open source or libre? + validations: + required: true + - type: textarea + id: features + attributes: + label: Features of this engine + description: Features of this engine: Doesn't track its users, fast, easy to integrate, or anything else that we can know about. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: true + options: + - 'General' + - 'Files' + - 'Images' + - 'IT' + - 'Map' + - 'Music' + - 'News' + - 'Science' + - 'Social Media' + - 'Videos' + validations: + required: true + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: false + options: + - 'Yes' + - 'No' + validations: + required: false + - type: textarea + id: extrainfo + attributes: + label: Additional information + description: Is there anything else we should know about this idea? + validations: + required: false + - type: markdown + attributes: + value: | + You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u) diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..8302bbf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,40 @@ +name: 💡 General Feature Request +description: Have a new idea/feature for Websurfx? Please suggest! +title: "✨ " +labels: ["⭐ goal: addition", "đŸšĻ status: awaiting triage"] +body: + - type: textarea + id: description + attributes: + label: Description + description: A brief description of the enhancement you propose, also include what you tried and what worked. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots + description: Please add screenshots if applicable + validations: + required: false + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: false + options: + - "Yes" + - "No" + validations: + required: false + - type: textarea + id: extrainfo + attributes: + label: Additional information + description: Is there anything else we should know about this idea? + validations: + required: false + - type: markdown + attributes: + value: | + You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 06c1ee5..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE] " -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/other.yml b/.github/ISSUE_TEMPLATE/other.yml new file mode 100644 index 0000000..a3d626c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.yml @@ -0,0 +1,36 @@ +name: 🧱 Other +description: Use this for any other issues. Please do NOT create blank issues +title: "🧱 " +labels: ["đŸšĻ status: awaiting triage"] +body: + - type: markdown + attributes: + value: "# Other issue" + - type: textarea + id: issuedescription + attributes: + label: What would you like to share? + description: Provide a clear and concise explanation of your issue. + validations: + required: true + - type: dropdown + id: assignee + attributes: + label: Do you want to work on this issue? + multiple: false + options: + - "Yes" + - "No" + validations: + required: false + - type: textarea + id: extrainfo + attributes: + label: Additional information + description: Is there anything else we should know about this issue? + validations: + required: false + - type: markdown + attributes: + value: | + You can also join our Discord community [here](https://discord.gg/SWnda7Mw5u) diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 0000000..cb9d0fb --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,27 @@ +'đŸ’ģ aspect: code': +- src/* +- Cargo.toml +- Cargo.lock +- Dockerfile +- docker-compose.yml +- websurfx/* + +'🤖 aspect: dx': +- '**/*.json' +- .dockerignore +- .gitignore +- .gitpod.Dockerfile +- .gitpod.yml +- .rusty-hook.toml +- PULL_REQUEST_TEMPLATE.md +- SECURITY.md +- .github/* +- .mega-linter.yml +- tests/* + +'📄 aspect: text': +- any: ['**/*.md', '!PULL_REQUEST_TEMPLATE.md', '!SECURITY.md'] +- LICENSE + +'🕹ī¸ aspect: interface': +- public/* diff --git a/.github/workflows/pr_labeler.yml b/.github/workflows/pr_labeler.yml new file mode 100644 index 0000000..bc7e72b --- /dev/null +++ b/.github/workflows/pr_labeler.yml @@ -0,0 +1,15 @@ +name: "Pull Request Auto Labeler" +on: +- pull_request_target + +jobs: + triage: + permissions: + contents: read + pull-requests: write + runs-on: ubuntu-latest + steps: + - uses: actions/labeler@v4 + with: + sync-labels: true + dot: true diff --git a/Dockerfile b/Dockerfile index 2611aca..e9339e5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -22,5 +22,7 @@ RUN cargo install --path . FROM gcr.io/distroless/cc-debian12 COPY --from=builder /app/public/ /opt/websurfx/public/ COPY --from=builder /app/websurfx/config.lua /etc/xdg/websurfx/config.lua +COPY --from=builder /app/websurfx/allowlist.txt /etc/xdg/websurfx/allowlist.txt +COPY --from=builder /app/websurfx/blocklist.txt /etc/xdg/websurfx/blocklist.txt COPY --from=builder /usr/local/cargo/bin/* /usr/local/bin/ CMD ["websurfx"]