github
/
nginxconfig.io
mirror of https://github.com/digitalocean/nginxconfig.io
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add onion location support (#207) 

* Add initial onion tab

* Add some explaining copy

* Add to generator

* Add strings to language packs

* Add external learn more link
pull/208/head
Matt (IPv4) Cowley 2021-01-04 15:41:56 +00:00 committed by GitHub
parent 2b459b47ee
commit 0cefd5ddef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 289 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/nginxconfig/generators/conf/website.conf.js
View File

@ -150,6 +150,12 @@ export default (domain, domains, global) => {
// HTTPS
serverConfig.push(...sslConfig(domain, global));
// Onion location
if (domain.onion.onionLocation.computed) {
serverConfig.push(['# Onion services', '']);
serverConfig.push(['add_header Onion-Location', `http://${domain.onion.onionLocation.computed}$request_uri`]);
}
// HSTS
if (!commonHsts(domains) && domain.https.hsts.computed) {
serverConfig.push(['# HSTS', '']);

3
src/nginxconfig/i18n/en/templates/domain_sections/index.js
View File

@ -33,5 +33,6 @@ import reverseProxy from './reverse_proxy';
import routing from './routing';
import server from './server';
import restrict from './restrict';
import onion from './onion';
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict };
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict, onion };

36
src/nginxconfig/i18n/en/templates/domain_sections/onion.js Normal file
View File

@ -0,0 +1,36 @@
/*
Copyright 2020 DigitalOcean
This code is licensed under the MIT License.
You may obtain a copy of the License at
https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE or https://mit-license.org/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
const onion = 'Onion';
export default {
onion,
onionLocation: `${onion} location`,
provideAnOnionLocationToSetOnionLocationHeader: 'Provide an onion location address to set the Onion-Location header for your site.',
letsVisitorsKnownOnionServicesIsAvailable: 'This lets visitors know that an onion services version of your site is available for Tor browsers.',
learnMoreAboutOnionServices: 'Learn more about Onion services',
onionLocationExpectedToEndWithOnion: 'Onion location addresses normally end with `.onion`.',
};

3
src/nginxconfig/i18n/pt-br/templates/domain_sections/index.js
View File

@ -33,5 +33,6 @@ import reverseProxy from './reverse_proxy';
import routing from './routing';
import server from './server';
import restrict from './restrict';
import onion from './onion';
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict };
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict, onion };

36
src/nginxconfig/i18n/pt-br/templates/domain_sections/onion.js Normal file
View File

@ -0,0 +1,36 @@
/*
Copyright 2020 DigitalOcean
This code is licensed under the MIT License.
You may obtain a copy of the License at
https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE or https://mit-license.org/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
const onion = 'Onion';
export default {
onion,
onionLocation: `${onion} location`, // TODO: translate
provideAnOnionLocationToSetOnionLocationHeader: 'Provide an onion location address to set the Onion-Location header for your site.', // TODO: translate
letsVisitorsKnownOnionServicesIsAvailable: 'This lets visitors know that an onion services version of your site is available for Tor browsers.', // TODO: translate
learnMoreAboutOnionServices: 'Learn more about Onion services', // TODO: translate
onionLocationExpectedToEndWithOnion: 'Onion location addresses normally end with `.onion`.', // TODO: translate
};

3
src/nginxconfig/i18n/zh-cn/templates/domain_sections/index.js
View File

@ -33,5 +33,6 @@ import reverseProxy from './reverse_proxy';
import routing from './routing';
import server from './server';
import restrict from './restrict';
import onion from './onion';
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict };
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict, onion };

36
src/nginxconfig/i18n/zh-cn/templates/domain_sections/onion.js Normal file
View File

@ -0,0 +1,36 @@
/*
Copyright 2020 DigitalOcean
This code is licensed under the MIT License.
You may obtain a copy of the License at
https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE or https://mit-license.org/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
const onion = 'Onion';
export default {
onion,
onionLocation: `${onion} location`, // TODO: translate
provideAnOnionLocationToSetOnionLocationHeader: 'Provide an onion location address to set the Onion-Location header for your site.', // TODO: translate
letsVisitorsKnownOnionServicesIsAvailable: 'This lets visitors know that an onion services version of your site is available for Tor browsers.', // TODO: translate
learnMoreAboutOnionServices: 'Learn more about Onion services', // TODO: translate
onionLocationExpectedToEndWithOnion: 'Onion location addresses normally end with `.onion`.', // TODO: translate
};

3
src/nginxconfig/i18n/zh-tw/templates/domain_sections/index.js
View File

@ -33,5 +33,6 @@ import reverseProxy from './reverse_proxy';
import routing from './routing';
import server from './server';
import restrict from './restrict';
import onion from './onion';
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict };
export default { https, logging, php, presets, python, reverseProxy, routing, server, restrict, onion };

36
src/nginxconfig/i18n/zh-tw/templates/domain_sections/onion.js Normal file
View File

@ -0,0 +1,36 @@
/*
Copyright 2020 DigitalOcean
This code is licensed under the MIT License.
You may obtain a copy of the License at
https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE or https://mit-license.org/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
const onion = 'Onion';
export default {
onion,
onionLocation: `${onion} location`, // TODO: translate
provideAnOnionLocationToSetOnionLocationHeader: 'Provide an onion location address to set the Onion-Location header for your site.', // TODO: translate
letsVisitorsKnownOnionServicesIsAvailable: 'This lets visitors know that an onion services version of your site is available for Tor browsers.', // TODO: translate
learnMoreAboutOnionServices: 'Learn more about Onion services', // TODO: translate
onionLocationExpectedToEndWithOnion: 'Onion location addresses normally end with `.onion`.', // TODO: translate
};

18
src/nginxconfig/scss/_fields.scss
View File

@ -49,6 +49,12 @@ THE SOFTWARE.
&.is-aligned-top {
align-items: flex-start;
> .field-label {
&.has-margin-top {
margin-top: .75rem;
}
}
> p {
@include sailec-medium;
@ -116,6 +122,18 @@ THE SOFTWARE.
display: inline-block;
font-size: 14px;
padding: 0 .5rem;
&.message {
padding: 0;
.message-body {
display: inline-block;
}
}
.fa-external-link-alt {
margin: 0 0 0 .25rem;
}
}
}

1
src/nginxconfig/templates/domain_sections/index.js
View File

@ -32,3 +32,4 @@ export { default as ReverseProxy } from './reverse_proxy';
export { default as Routing } from './routing';
export { default as Logging } from './logging';
export { default as Restrict } from './restrict';
export { default as Onion } from './onion';

112
src/nginxconfig/templates/domain_sections/onion.vue Normal file
View File

@ -0,0 +1,112 @@
<!--
Copyright 2020 DigitalOcean
This code is licensed under the MIT License.
You may obtain a copy of the License at
https://github.com/digitalocean/nginxconfig.io/blob/master/LICENSE or https://mit-license.org/
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions :
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-->
<template>
<div>
<div class="field is-horizontal is-aligned-top">
<div class="field-label has-margin-top">
<label class="label">{{ $t('templates.domainSections.onion.onionLocation') }}</label>
</div>
<div class="field-body">
<div class="field">
<div :class="`control${onionLocationChanged ? ' is-changed' : ''}`">
<input v-model="onionLocation" class="input" type="text" :placeholder="$props.data.onionLocation.placeholder" />
</div>
<template v-if="!onionLocationChanged">
<div class="control">
<label class="text">
{{ $t('templates.domainSections.onion.provideAnOnionLocationToSetOnionLocationHeader') }}
</label>
</div>
<div class="control">
<label class="text">
{{ $t('templates.domainSections.onion.letsVisitorsKnownOnionServicesIsAvailable') }}
</label>
</div>
<div class="control">
<label class="text">
<ExternalLink :text="$t('templates.domainSections.onion.learnMoreAboutOnionServices')"
link="https://community.torproject.org/onion-services/"
></ExternalLink>
</label>
</div>
</template>
<div class="control" v-if="incorrectEnding">
<label class="text message is-warning">
<span class="message-body">
{{ $t('templates.domainSections.onion.onionLocationExpectedToEndWithOnion') }}
</span>
</label>
</div>
</div>
</div>
</div>
</div>
</template>
<script>
import ExternalLink from 'do-vue/src/templates/external_link';
import delegatedFromDefaults from '../../util/delegated_from_defaults';
import computedFromDefaults from '../../util/computed_from_defaults';
const defaults = {
onionLocation: {
default: '',
placeholder: '<your-onion-address>.onion',
enabled: true,
},
};
export default {
name: 'DomainOnion', // Component name
display: 'templates.domainSections.onion.onion', // Display name for tab (i18n key)
key: 'onion', // Key for data in parent
delegated: delegatedFromDefaults(defaults), // Data the parent will present here
components: {
ExternalLink,
},
props: {
data: Object, // Data delegated back to us from parent
},
computed: {
...computedFromDefaults(defaults, 'onion'), // Getters & setters for the delegated data
incorrectEnding() {
return this.onionLocationChanged && !this.$props.data.onionLocation.computed.endsWith('.onion');
},
},
watch: {
'$props.data.onionLocation': {
handler(data) {
// Drop http(s)://
data.computed = data.computed.replace(/^https?:\/\//, '');
},
deep: true,
},
},
};
</script>